@jchat/addon-sdk 1.0.0-alpha.4 → 1.0.0-alpha.7

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @jchat/addon-sdk
 
+## 1.0.0-alpha.7
+
+### Minor Changes
+
+- 7cef24c: - Enhance addon package diagnostics with semantic version compatibility validation for JChat host and Addon SDK
+  - Add support for local workspace development, sandbox test harnesses, and distribution packaging
+  - Improve runtime license verification and multi-environment path resolution
+  - Update addon generator templates with 20-language i18n support, standard scripts, and type definitions
+
+## 1.0.0-alpha.6
+
+## 1.0.0-alpha.5
+
+### Minor Changes
+
+- 9755c28: Export curated UI components, types, and Tailwind styles from `@jchat/addon-sdk/ui` (`@jchat/addon-sdk/ui/tailwind.css`) for sandbox and third-party addon developers.
+
+### Patch Changes
+
+- ad4b00c: Add `OWNER_SETTINGS` (`"owner-settings"`) and `ADDON_SETTINGS` (`"addon-settings"`) to `MOUNT_POINTS` constant and strictly type `MountPoint` union to official mount points. Remove legacy `ConfigSchemaField` and `configSchema` from `AddonManifest` in favor of mount-point-driven settings.
+- ada430f: Formatted type declarations in the Addon SDK to align with project style guidelines.
+
 ## 1.0.0-alpha.4
 
 ### Patch Changes

package/LICENSE

@@ -1,201 +1,23 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
+CUSTOM COMMERCIAL END USER LICENSE AGREEMENT (EULA)
 
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+Copyright (c) 2026 JChat Project. All rights reserved.
 
-   1. Definitions.
+1. DEFINITIONS
+"Software" refers to this npm package and its source code.
+"Authorized Application" refers strictly to the application known as "JChat".
 
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
+2. LICENSE GRANT
+Subject to the terms of this Agreement and payment of any applicable fees, the 
+Licensor grants you a non-exclusive, non-transferable, revocable license to 
+download, install, and use the Software.
 
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
+3. RESTRICTIONS ON USE
+You are expressly prohibited from using this Software, in whole or in part, 
+in any application, product, or service other than the Authorized Application (JChat). 
+Any deployment, linking, execution, or inclusion of this Software into an 
+application that is not JChat constitutes a breach of this contract and 
+an infringement of copyright law.
 
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright 2026 Md. Jabarullah
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+4. NO REDISTRIBUTION
+You may not sub-license, rent, lease, or publicly redistribute this Software 
+to any third party without explicit written consent from the Licensor.

package/dist/cli.d.mts

@@ -0,0 +1,36 @@
+import { t as AddonManifest } from "./contracts.mjs";
+import { InlineConfig } from "vite";
+//#region src/cli.d.ts
+/** Options for resolving addon build configuration. */
+interface AddonCliOptions {
+  rootDir?: string;
+  command?: "build" | "dev" | "help";
+  mode?: "production" | "development";
+  watch?: boolean;
+  zip?: boolean;
+  signingPrivateKey?: string;
+}
+/**
+ * Automatically loads the addon manifest from `src/manifest.ts`, `src/manifest.js`, or
+ * `src/manifest.json`.
+ *
+ * @param rootDir - Root directory of the addon workspace.
+ * @returns Parsed {@link AddonManifest}.
+ */
+declare function loadAddonManifest(rootDir: string): Promise<AddonManifest>;
+/**
+ * Resolves the full Vite configuration for building a JChat addon, merging user custom configs if
+ * present.
+ *
+ * @param options - CLI build options.
+ * @returns Fully merged {@link InlineConfig} for Vite.
+ */
+declare function resolveAddonBuildConfig(options?: AddonCliOptions): Promise<InlineConfig>;
+/**
+ * Main CLI handler for `jchat-addon`.
+ *
+ * @param args - CLI arguments (defaults to `process.argv.slice(2)`).
+ */
+declare function runAddonCli(args?: string[]): Promise<void>;
+//#endregion
+export { AddonCliOptions, loadAddonManifest, resolveAddonBuildConfig, runAddonCli };

package/dist/cli.mjs

@@ -0,0 +1,135 @@
+import { jchatAddon } from "./vite.mjs";
+import fs from "node:fs";
+import path from "node:path";
+import tailwindcss from "@tailwindcss/vite";
+import { pathToFileURL } from "node:url";
+import { build, loadConfigFromFile, mergeConfig } from "vite";
+//#region src/cli.ts
+function hasPlugin(plugins, name) {
+	if (!plugins) return false;
+	if (Array.isArray(plugins)) return plugins.some((p) => hasPlugin(p, name));
+	if (typeof plugins === "object" && plugins !== null && "name" in plugins && plugins.name === name) return true;
+	return false;
+}
+/**
+* Automatically loads the addon manifest from `src/manifest.ts`, `src/manifest.js`, or
+* `src/manifest.json`.
+*
+* @param rootDir - Root directory of the addon workspace.
+* @returns Parsed {@link AddonManifest}.
+*/
+async function loadAddonManifest(rootDir) {
+	const existingPath = [
+		path.resolve(rootDir, "src/manifest.ts"),
+		path.resolve(rootDir, "src/manifest.js"),
+		path.resolve(rootDir, "src/manifest.mjs"),
+		path.resolve(rootDir, "src/manifest.json")
+	].find((filePath) => fs.existsSync(filePath));
+	if (existingPath) {
+		if (existingPath.endsWith(".json")) {
+			const text = fs.readFileSync(existingPath, "utf-8");
+			return JSON.parse(text);
+		}
+		const imported = await import(pathToFileURL(existingPath).href);
+		return imported.default || imported.manifest;
+	}
+	throw new Error(`Could not find addon manifest in ${rootDir}/src (expected manifest.ts or manifest.json)`);
+}
+/**
+* Resolves the full Vite configuration for building a JChat addon, merging user custom configs if
+* present.
+*
+* @param options - CLI build options.
+* @returns Fully merged {@link InlineConfig} for Vite.
+*/
+async function resolveAddonBuildConfig(options = {}) {
+	const rootDir = path.resolve(options.rootDir || process.cwd());
+	const isDev = options.command === "dev" || options.mode === "development";
+	const mode = options.mode || (isDev ? "development" : "production");
+	const watch = options.watch ?? options.command === "dev";
+	const manifest = await loadAddonManifest(rootDir);
+	const baseConfig = {
+		root: rootDir,
+		configFile: false,
+		mode,
+		plugins: [tailwindcss(), jchatAddon({
+			manifest,
+			development: isDev,
+			zip: options.zip,
+			signingPrivateKey: options.signingPrivateKey
+		})],
+		build: { watch: watch ? {} : null }
+	};
+	const customConfigPath = [
+		"vite.config.ts",
+		"vite.config.js",
+		"vite.config.mjs",
+		"vite.config.cjs"
+	].map((file) => path.resolve(rootDir, file)).find((file) => fs.existsSync(file));
+	if (customConfigPath) {
+		const loaded = await loadConfigFromFile({
+			command: "build",
+			mode
+		}, customConfigPath, rootDir);
+		if (loaded?.config) {
+			if (hasPlugin(loaded.config.plugins, "jchat-addon")) return mergeConfig(loaded.config, {
+				root: rootDir,
+				mode,
+				build: { watch: watch ? {} : null }
+			});
+			return mergeConfig(baseConfig, loaded.config);
+		}
+	}
+	return baseConfig;
+}
+/**
+* Main CLI handler for `jchat-addon`.
+*
+* @param args - CLI arguments (defaults to `process.argv.slice(2)`).
+*/
+async function runAddonCli(args = process.argv.slice(2)) {
+	let command = "build";
+	let watch = false;
+	let mode;
+	let zip;
+	for (const arg of args) if (arg === "dev") {
+		command = "dev";
+		watch = true;
+		mode = "development";
+	} else if (arg === "build") command = "build";
+	else if (arg === "--watch" || arg === "-w") watch = true;
+	else if (arg === "--dev") mode = "development";
+	else if (arg === "--prod" || arg === "--production") mode = "production";
+	else if (arg === "--no-zip") zip = false;
+	else if (arg === "--zip") zip = true;
+	else if (arg === "--help" || arg === "-h") command = "help";
+	if (command === "help") {
+		console.log(`
+JChat Addon CLI (jchat-addon)
+
+Usage:
+  jchat-addon build    Build the addon for production
+  jchat-addon dev      Build and watch the addon in development mode
+
+Options:
+  --watch, -w          Watch files for changes
+  --dev                Run in development mode
+  --prod               Run in production mode
+  --no-zip             Do not package the build into a .zip archive
+  --help, -h           Show this help message
+`);
+		return;
+	}
+	await build(await resolveAddonBuildConfig({
+		command,
+		mode,
+		watch,
+		zip
+	}));
+}
+if (import.meta.main) runAddonCli().catch((error) => {
+	console.error("❌ Addon build failed:", error);
+	process.exit(1);
+});
+//#endregion
+export { loadAddonManifest, resolveAddonBuildConfig, runAddonCli };

package/dist/contracts.d.mts

@@ -1,23 +1,4 @@
 //#region src/contracts.d.ts
-type AddonPermission = string;
-/**
- * Defines a single configuration field for an addon's settings panel. These are shown to site
- * admins in the Jchat dashboard.
- */
-interface ConfigSchemaField {
-  /** Unique key used to store and retrieve the value in `getConfig` */
-  key: string;
-  /** Data type for validation and UI rendering */
-  type: "string" | "number" | "boolean";
-  /** Human-readable label shown in the settings UI */
-  label: string;
-  /** If true, the admin must provide a value before saving */
-  required?: boolean;
-  /** Whether the value is sensitive (encrypted at rest and masked in the UI) */
-  secret?: boolean;
-  /** Default value pre-filled in the settings form for new installations */
-  default?: string | number | boolean;
-}
 /** Definition of a custom permission introduced by an addon. */
 interface AddonPermissionDefinition {
   /** Permission identifier (recommended: `addon.<id>.<action>`) */
@@ -53,8 +34,14 @@ declare const MOUNT_POINTS: {
   readonly CHAT_PLUS_MENU: "chat-plus-menu";
   /** Custom tab in the emoji/gif selection panel */
   readonly EMOJI_PICKER_GIF_TAB: "emoji-picker-gif-tab";
+  /** Custom tab in the emoji/sticker selection panel */
+  readonly EMOJI_PICKER_STICKER_TAB: "emoji-picker-sticker-tab";
   /** Full-screen or modal dialog specifically for TubeScan */
   readonly TUBESCAN_DIALOG: "tubescan-dialog";
+  /** Dedicated settings panel rendered in the Owner Dashboard */
+  readonly OWNER_SETTINGS: "owner-settings";
+  /** Dedicated settings panel rendered in the Site Admin Dashboard */
+  readonly ADDON_SETTINGS: "addon-settings";
 };
 /** Union type of all valid addon mount points. */
 type MountPoint = (typeof MOUNT_POINTS)[keyof typeof MOUNT_POINTS];
@@ -77,6 +64,13 @@ interface AddonManifest {
   homepage?: string;
   /** SPDX license identifier (e.g. `MIT`) */
   license?: string;
+  /**
+   * Supported language codes (e.g. ["ar", "de", "en", "es", "fr", "hi", "kn", "ml", "ta", "te",
+   * "ur"])
+   */
+  locales?: string[];
+  /** Default fallback language code (e.g. "en") */
+  defaultLocale?: string;
   /** Host and SDK versions this directly executed plugin was built and tested against */
   compatibility: {
     /** Supported JChat versions as a semantic-version range, for example `^1.0.0` */
@@ -118,13 +112,11 @@ interface AddonManifest {
    * The minimum permission required to see or use this addon. If provided, the host gates
    * visibility in the UI and access to all server routes.
    */
-  accessPermission?: AddonPermission;
+  accessPermission?: string;
   /** Full list of all permissions used by this addon for informational purposes */
-  permissions?: AddonPermission[];
+  permissions?: string[];
   /** Custom permissions that should be registered with the host application on installation */
   permissionDefinitions?: AddonPermissionDefinition[];
-  /** Settings form structure shown to site admins. Values are stored encrypted per site */
-  configSchema?: ConfigSchemaField[];
 }
 //#endregion
-export { MOUNT_POINTS as a, ConfigSchemaField as i, AddonPermission as n, MountPoint as o, AddonPermissionDefinition as r, AddonManifest as t };
+export { MountPoint as i, AddonPermissionDefinition as n, MOUNT_POINTS as r, AddonManifest as t };

package/dist/diagnostics.d.mts

@@ -37,7 +37,7 @@ interface AddonPackageDiagnosticOptions {
  * current major version.
  *
  * @example
- *   ```ts
+ *   ;```ts
  *   createCompatibleMajorRange("1.4.2") // returns ">=1.4.2 <2.0.0"
  *   ```
  *

package/dist/diagnostics.mjs

@@ -6,7 +6,7 @@ import * as path$1 from "node:path";
 * current major version.
 *
 * @example
-*   ```ts
+*   ;```ts
 *   createCompatibleMajorRange("1.4.2") // returns ">=1.4.2 <2.0.0"
 *   ```
 *