@cometchat/skills-cli 2.0.0

package/dist/registry/schemas/template.schema.json

@@ -0,0 +1,142 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://cometchat.com/skills/schemas/template.schema.json",
+  "title": "CometChat Skills Template",
+  "description": "Schema for an experience-template manifest. One file per (framework × experience) combo.",
+  "type": "object",
+  "required": [
+    "version",
+    "experience_id",
+    "framework",
+    "sdk_compatibility",
+    "deps",
+    "env_vars",
+    "files"
+  ],
+  "additionalProperties": false,
+  "properties": {
+    "version": {
+      "type": "string",
+      "description": "Template version. Bumped whenever the template content changes. Used by drift detection.",
+      "pattern": "^\\d+\\.\\d+\\.\\d+$"
+    },
+    "experience_id": {
+      "type": "integer",
+      "enum": [1, 2, 3],
+      "description": "Which experience this template implements."
+    },
+    "framework": {
+      "type": "string",
+      "enum": ["reactjs", "nextjs", "react-router", "astro"],
+      "description": "Which framework this template targets."
+    },
+    "sdk_compatibility": {
+      "type": "string",
+      "description": "Semver range of @cometchat/chat-uikit-react this template is compatible with.",
+      "examples": [">=6.0.0 <7.0.0"]
+    },
+    "default_placement": {
+      "type": "string",
+      "enum": ["dedicated-route", "embed", "spa-root"],
+      "description": "Where the chat UI lands by default. spa-root means it replaces the App.tsx for SPA frameworks."
+    },
+    "deps": {
+      "type": "array",
+      "description": "npm packages to install.",
+      "items": {
+        "type": "object",
+        "required": ["name", "version"],
+        "additionalProperties": false,
+        "properties": {
+          "name": { "type": "string" },
+          "version": { "type": "string" },
+          "dev": { "type": "boolean", "default": false }
+        }
+      }
+    },
+    "env_vars": {
+      "type": "array",
+      "description": "Environment variables that need to be set in .env*. The {{ENV_PREFIX}} placeholder is substituted at apply time based on detected framework.",
+      "items": {
+        "type": "object",
+        "required": ["name", "required"],
+        "additionalProperties": false,
+        "properties": {
+          "name": { "type": "string" },
+          "required": { "type": "boolean" },
+          "secret": { "type": "boolean", "default": false },
+          "description": { "type": "string" }
+        }
+      }
+    },
+    "files": {
+      "type": "array",
+      "description": "Files to create or patch. Order matters — patches apply in array order.",
+      "items": {
+        "oneOf": [
+          {
+            "type": "object",
+            "required": ["path", "action", "template_ref"],
+            "additionalProperties": false,
+            "properties": {
+              "path": {
+                "type": "string",
+                "description": "Destination path relative to project root. May contain {{VAR}} placeholders."
+              },
+              "action": { "const": "create" },
+              "template_ref": {
+                "type": "string",
+                "description": "Path to the template file inside this template's directory."
+              },
+              "owned": {
+                "type": "boolean",
+                "default": true,
+                "description": "Whether this file is owned by CometChat. Owned files can be cleanly removed by uninstall."
+              }
+            }
+          },
+          {
+            "type": "object",
+            "required": ["path", "action"],
+            "additionalProperties": false,
+            "properties": {
+              "path": { "type": "string" },
+              "action": { "const": "patch" },
+              "patch_mode": {
+                "type": "string",
+                "enum": ["prepend", "append", "insert-after", "insert-before", "replace-section"],
+                "default": "prepend"
+              },
+              "patch_content": {
+                "type": "string",
+                "description": "Inline patch content (for small patches)."
+              },
+              "patch_ref": {
+                "type": "string",
+                "description": "Path to a patch file (for larger patches)."
+              },
+              "anchor": {
+                "type": "string",
+                "description": "For insert-after / replace-section: the anchor string to find in the target file."
+              },
+              "skip_if_exists": {
+                "type": "string",
+                "description": "If this string is already in the file, skip the patch (idempotency)."
+              }
+            }
+          }
+        ]
+      }
+    },
+    "verify_rules": {
+      "type": "array",
+      "description": "Names of AST verification rules that must pass after this template is applied.",
+      "items": { "type": "string" }
+    },
+    "next_steps": {
+      "type": "array",
+      "description": "Human-readable instructions to show the user after a successful apply.",
+      "items": { "type": "string" }
+    }
+  }
+}

package/dist/registry/v6/experiences/1-conversation-list/astro.template.json

@@ -0,0 +1,89 @@
+{
+  "$schema": "../../../schemas/template.schema.json",
+  "version": "1.0.0",
+  "experience_id": 1,
+  "framework": "astro",
+  "sdk_compatibility": ">=6.0.0 <7.0.0",
+  "default_placement": "dedicated-route",
+  "deps": [
+    {
+      "name": "@cometchat/chat-uikit-react",
+      "version": "^6"
+    },
+    {
+      "name": "@cometchat/chat-sdk-javascript",
+      "version": "^4"
+    },
+    {
+      "name": "@astrojs/react",
+      "version": "^4"
+    },
+    {
+      "name": "react",
+      "version": "^18"
+    },
+    {
+      "name": "react-dom",
+      "version": "^18"
+    }
+  ],
+  "env_vars": [
+    {
+      "name": "{{ENV_PREFIX}}COMETCHAT_APP_ID",
+      "required": true,
+      "description": "CometChat App ID from your dashboard"
+    },
+    {
+      "name": "{{ENV_PREFIX}}COMETCHAT_REGION",
+      "required": true,
+      "description": "CometChat region (us, eu, in, etc.)"
+    },
+    {
+      "name": "{{ENV_PREFIX}}COMETCHAT_AUTH_KEY",
+      "required": true,
+      "secret": true,
+      "description": "CometChat Auth Key (development only)"
+    }
+  ],
+  "files": [
+    {
+      "path": "src/cometchat/ChatApp.tsx",
+      "action": "create",
+      "template_ref": "ChatApp.tsx.tpl",
+      "owned": true
+    },
+    {
+      "path": "src/cometchat/ChatApp.css",
+      "action": "create",
+      "template_ref": "ChatApp.css.tpl",
+      "owned": true
+    },
+    {
+      "path": "src/cometchat/CometChatSelector.tsx",
+      "action": "create",
+      "template_ref": "CometChatSelector.tsx.tpl",
+      "owned": true
+    },
+    {
+      "path": "src/pages/chat.astro",
+      "action": "create",
+      "template_ref": "chat.astro.tpl",
+      "owned": true,
+      "is_entry": true
+    }
+  ],
+  "verify_rules": [
+    "init_before_login",
+    "no_user_and_group_same_component",
+    "no_auth_key_in_source",
+    "render_gated_on_login_resolve",
+    "error_ui_visible_on_failure"
+  ],
+  "next_steps": [
+    "If `@astrojs/react` isn't installed yet, run: `npx astro add react`",
+    "Run `npm run dev` to start the dev server",
+    "Visit http://localhost:4321/chat",
+    "Note: css-variables.css is imported inside ChatApp.tsx (not in any global stylesheet) — this is required for Astro client:only islands",
+    "When ready for production, run `cometchat apply --production` to set up server-side auth tokens"
+  ]
+}

package/dist/registry/v6/experiences/1-conversation-list/nextjs-pages.template.json

@@ -0,0 +1,83 @@
+{
+  "$schema": "../../../schemas/template.schema.json",
+  "version": "1.0.0",
+  "experience_id": 1,
+  "framework": "nextjs-pages",
+  "sdk_compatibility": ">=6.0.0 <7.0.0",
+  "default_placement": "dedicated-route",
+  "deps": [
+    {
+      "name": "@cometchat/chat-uikit-react",
+      "version": "^6"
+    },
+    {
+      "name": "@cometchat/chat-sdk-javascript",
+      "version": "^4"
+    }
+  ],
+  "env_vars": [
+    {
+      "name": "{{ENV_PREFIX}}COMETCHAT_APP_ID",
+      "required": true,
+      "description": "CometChat App ID from your dashboard"
+    },
+    {
+      "name": "{{ENV_PREFIX}}COMETCHAT_REGION",
+      "required": true,
+      "description": "CometChat region (us, eu, in, etc.)"
+    },
+    {
+      "name": "{{ENV_PREFIX}}COMETCHAT_AUTH_KEY",
+      "required": true,
+      "secret": true,
+      "description": "CometChat Auth Key (development only)"
+    }
+  ],
+  "files": [
+    {
+      "path": "src/cometchat/CometChatNoSSR.tsx",
+      "action": "create",
+      "template_ref": "CometChatNoSSR.tsx.tpl",
+      "owned": true
+    },
+    {
+      "path": "src/cometchat/CometChatNoSSR.css",
+      "action": "create",
+      "template_ref": "CometChatNoSSR.css.tpl",
+      "owned": true
+    },
+    {
+      "path": "src/cometchat/CometChatSelector.tsx",
+      "action": "create",
+      "template_ref": "CometChatSelector.tsx.tpl",
+      "owned": true
+    },
+    {
+      "path": "src/pages/chat.tsx",
+      "action": "create",
+      "template_ref": "chat-page.tsx.tpl",
+      "owned": true,
+      "is_entry": true
+    },
+    {
+      "path": "src/styles/globals.css",
+      "action": "patch",
+      "patch_mode": "prepend",
+      "patch_content": "@import url(\"@cometchat/chat-uikit-react/css-variables.css\");\n",
+      "skip_if_exists": "@cometchat/chat-uikit-react/css-variables.css"
+    }
+  ],
+  "verify_rules": [
+    "css_variables_imported_once",
+    "init_before_login",
+    "no_user_and_group_same_component",
+    "no_auth_key_in_source",
+    "render_gated_on_login_resolve",
+    "error_ui_visible_on_failure"
+  ],
+  "next_steps": [
+    "Run `npm run dev` to start the dev server",
+    "Visit http://localhost:3000/chat",
+    "When ready for production, run `cometchat apply --production` to set up server-side auth tokens"
+  ]
+}

package/dist/registry/v6/experiences/1-conversation-list/nextjs.template.json

@@ -0,0 +1,83 @@
+{
+  "$schema": "../../../schemas/template.schema.json",
+  "version": "1.0.0",
+  "experience_id": 1,
+  "framework": "nextjs",
+  "sdk_compatibility": ">=6.0.0 <7.0.0",
+  "default_placement": "dedicated-route",
+  "deps": [
+    {
+      "name": "@cometchat/chat-uikit-react",
+      "version": "^6"
+    },
+    {
+      "name": "@cometchat/chat-sdk-javascript",
+      "version": "^4"
+    }
+  ],
+  "env_vars": [
+    {
+      "name": "{{ENV_PREFIX}}COMETCHAT_APP_ID",
+      "required": true,
+      "description": "CometChat App ID from your dashboard"
+    },
+    {
+      "name": "{{ENV_PREFIX}}COMETCHAT_REGION",
+      "required": true,
+      "description": "CometChat region (us, eu, in, etc.)"
+    },
+    {
+      "name": "{{ENV_PREFIX}}COMETCHAT_AUTH_KEY",
+      "required": true,
+      "secret": true,
+      "description": "CometChat Auth Key (development only)"
+    }
+  ],
+  "files": [
+    {
+      "path": "src/app/cometchat/CometChatNoSSR.tsx",
+      "action": "create",
+      "template_ref": "CometChatNoSSR.tsx.tpl",
+      "owned": true
+    },
+    {
+      "path": "src/app/cometchat/CometChatNoSSR.css",
+      "action": "create",
+      "template_ref": "CometChatNoSSR.css.tpl",
+      "owned": true
+    },
+    {
+      "path": "src/app/cometchat/CometChatSelector.tsx",
+      "action": "create",
+      "template_ref": "CometChatSelector.tsx.tpl",
+      "owned": true
+    },
+    {
+      "path": "src/app/chat/page.tsx",
+      "action": "create",
+      "template_ref": "chat-page.tsx.tpl",
+      "owned": true,
+      "is_entry": true
+    },
+    {
+      "path": "src/app/globals.css",
+      "action": "patch",
+      "patch_mode": "prepend",
+      "patch_content": "@import url(\"@cometchat/chat-uikit-react/css-variables.css\");\n",
+      "skip_if_exists": "@cometchat/chat-uikit-react/css-variables.css"
+    }
+  ],
+  "verify_rules": [
+    "css_variables_imported_once",
+    "init_before_login",
+    "no_user_and_group_same_component",
+    "no_auth_key_in_source",
+    "render_gated_on_login_resolve",
+    "error_ui_visible_on_failure"
+  ],
+  "next_steps": [
+    "Run `npm run dev` to start the dev server",
+    "Visit http://localhost:3000/chat",
+    "When ready for production, run `cometchat apply --production` to set up server-side auth tokens"
+  ]
+}

package/dist/registry/v6/experiences/1-conversation-list/react-router.template.json

@@ -0,0 +1,102 @@
+{
+  "$schema": "../../../schemas/template.schema.json",
+  "version": "1.0.0",
+  "experience_id": 1,
+  "framework": "react-router",
+  "sdk_compatibility": ">=6.0.0 <7.0.0",
+  "default_placement": "dedicated-route",
+  "deps": [
+    {
+      "name": "@cometchat/chat-uikit-react",
+      "version": "^6"
+    },
+    {
+      "name": "@cometchat/chat-sdk-javascript",
+      "version": "^4"
+    }
+  ],
+  "env_vars": [
+    {
+      "name": "{{ENV_PREFIX}}COMETCHAT_APP_ID",
+      "required": true,
+      "description": "CometChat App ID from your dashboard"
+    },
+    {
+      "name": "{{ENV_PREFIX}}COMETCHAT_REGION",
+      "required": true,
+      "description": "CometChat region (us, eu, in, etc.)"
+    },
+    {
+      "name": "{{ENV_PREFIX}}COMETCHAT_AUTH_KEY",
+      "required": true,
+      "secret": true,
+      "description": "CometChat Auth Key (development only)"
+    }
+  ],
+  "files": [
+    {
+      "path": "app/cometchat/CometChatNoSSR.tsx",
+      "action": "create",
+      "template_ref": "CometChatNoSSR.tsx.tpl",
+      "owned": true
+    },
+    {
+      "path": "app/cometchat/CometChatNoSSR.css",
+      "action": "create",
+      "template_ref": "CometChatNoSSR.css.tpl",
+      "owned": true
+    },
+    {
+      "path": "app/cometchat/CometChatSelector.tsx",
+      "action": "create",
+      "template_ref": "CometChatSelector.tsx.tpl",
+      "owned": true
+    },
+    {
+      "path": "app/routes/CometChat.tsx",
+      "action": "create",
+      "template_ref": "CometChat-route.tsx.tpl",
+      "owned": true,
+      "is_entry": true
+    },
+    {
+      "path": "app/routes.ts",
+      "action": "patch",
+      "patch_mode": "replace-section",
+      "anchor": "import { type RouteConfig, index }",
+      "patch_content": "import { type RouteConfig, index, route } from \"@react-router/dev/routes\";",
+      "skip_if_exists": "import { type RouteConfig, index, route }",
+      "embed_skip": true
+    },
+    {
+      "path": "app/routes.ts",
+      "action": "patch",
+      "patch_mode": "insert-before",
+      "anchor": "] satisfies RouteConfig",
+      "patch_content": "  route(\"chat\", \"routes/CometChat.tsx\"),\n",
+      "skip_if_exists": "routes/CometChat.tsx",
+      "embed_skip": true
+    },
+    {
+      "path": "app/app.css",
+      "action": "patch",
+      "patch_mode": "prepend",
+      "patch_content": "@import url(\"@cometchat/chat-uikit-react/css-variables.css\");\n",
+      "skip_if_exists": "@cometchat/chat-uikit-react/css-variables.css"
+    }
+  ],
+  "verify_rules": [
+    "css_variables_imported_once",
+    "init_before_login",
+    "no_user_and_group_same_component",
+    "no_auth_key_in_source",
+    "render_gated_on_login_resolve",
+    "error_ui_visible_on_failure"
+  ],
+  "next_steps": [
+    "Add the chat route to app/routes.ts: route(\"chat\", \"routes/CometChat.tsx\")",
+    "Run `npm run dev` to start the dev server",
+    "Visit http://localhost:5173/chat",
+    "When ready for production, run `cometchat apply --production` to set up server-side auth tokens"
+  ]
+}

package/dist/registry/v6/experiences/1-conversation-list/reactjs.template.json

@@ -0,0 +1,86 @@
+{
+  "$schema": "../../../schemas/template.schema.json",
+  "version": "1.0.0",
+  "experience_id": 1,
+  "framework": "reactjs",
+  "sdk_compatibility": ">=6.0.0 <7.0.0",
+  "default_placement": "spa-root",
+  "deps": [
+    {
+      "name": "@cometchat/chat-uikit-react",
+      "version": "^6"
+    },
+    {
+      "name": "@cometchat/chat-sdk-javascript",
+      "version": "^4"
+    }
+  ],
+  "env_vars": [
+    {
+      "name": "{{ENV_PREFIX}}COMETCHAT_APP_ID",
+      "required": true,
+      "description": "CometChat App ID from your dashboard"
+    },
+    {
+      "name": "{{ENV_PREFIX}}COMETCHAT_REGION",
+      "required": true,
+      "description": "CometChat region (us, eu, in, etc.)"
+    },
+    {
+      "name": "{{ENV_PREFIX}}COMETCHAT_AUTH_KEY",
+      "required": true,
+      "secret": true,
+      "description": "CometChat Auth Key (development only — use auth tokens in production)"
+    }
+  ],
+  "files": [
+    {
+      "path": "src/main.tsx",
+      "action": "create",
+      "template_ref": "main.tsx.tpl",
+      "owned": true,
+      "embed_skip": true
+    },
+    {
+      "path": "src/App.tsx",
+      "action": "create",
+      "template_ref": "App.tsx.tpl",
+      "owned": true,
+      "is_entry": true
+    },
+    {
+      "path": "src/App.css",
+      "action": "create",
+      "template_ref": "App.css.tpl",
+      "owned": true,
+      "move_with_entry": true
+    },
+    {
+      "path": "src/cometchat/CometChatSelector.tsx",
+      "action": "create",
+      "template_ref": "CometChatSelector.tsx.tpl",
+      "owned": true
+    },
+    {
+      "path": "src/index.css",
+      "action": "patch",
+      "patch_mode": "prepend",
+      "patch_content": "@import url(\"@cometchat/chat-uikit-react/css-variables.css\");\n",
+      "skip_if_exists": "@cometchat/chat-uikit-react/css-variables.css"
+    }
+  ],
+  "verify_rules": [
+    "css_variables_imported_once",
+    "init_before_login",
+    "no_user_and_group_same_component",
+    "no_auth_key_in_source",
+    "render_gated_on_login_resolve",
+    "error_ui_visible_on_failure"
+  ],
+  "next_steps": [
+    "Run `npm run dev` to start the dev server",
+    "Visit http://localhost:5173",
+    "Click a conversation in the left panel to open it",
+    "When ready for production, run `cometchat apply --production` to set up server-side auth tokens"
+  ]
+}

package/dist/registry/v6/experiences/1-conversation-list/templates/astro/ChatApp.css.tpl

@@ -0,0 +1,39 @@
+.conversations-with-messages {
+  display: flex;
+  height: 100vh;
+  width: 100%;
+}
+
+.conversations-wrapper {
+  height: 100%;
+  width: 480px;
+  overflow: hidden;
+  display: flex;
+  flex-direction: column;
+}
+
+.conversations-wrapper > .cometchat {
+  overflow: hidden;
+}
+
+.messages-wrapper {
+  width: calc(100% - 480px);
+  height: 100%;
+  display: flex;
+  flex-direction: column;
+}
+
+.empty-conversation {
+  height: 100%;
+  width: 100%;
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  background: white;
+  color: var(--cometchat-text-color-secondary, #727272);
+  font: var(--cometchat-font-body-regular, 400 14px Roboto);
+}
+
+.cometchat .cometchat-message-composer {
+  border-radius: 0;
+}