codeplay-common 4.2.5 → 4.2.7

package/README.md

@@ -8,21 +8,25 @@ Make three build file for different store as per our requirement
 Based on store install various IAP plugins
 Make it to ionic project
 
-## Agent instruction templates
-
-Agent instructions are maintained independently under `agent-templates/v<version>/`.
-The version in `agent-templates/manifest.json` is installed by default. To pin a
-project to a specific instruction version, add this to the project's `package.json`:
-
-```json
-"codeplayCommon": {
-  "agentsVersion": "1.0"
-}
-```
-
-During npm installation, the selected template's `AGENTS.md` and `AGENTS/` folder
-are copied to the project root. Project-only files with different names inside
-`AGENTS/` are preserved.
+## Agent instructions
+
+Agent instructions are updated during `npm run build`, not during npm installation.
+The build script reads the `agents` version from
+`https://htmlcodeplay.com/code-play-plugin/versions.json` and downloads the matching
+`agents-<version>.zip` archive when the project has no agent instructions or the
+server version is newer.
+
+The ZIP root must contain `AGENTS.md` and `AGENTS/`. These are copied directly to
+the project root. The installed version is stored in `AGENTS/.codeplay-version`.
+Existing files with matching names are replaced; project-only files with other
+names inside `AGENTS/` are preserved.
+
+For example, publish `agents-1.1.zip` and add this entry to the server's
+`versions.json`:
+
+```json
+"agents": "1.1"
+```
 
 Donate to get full code including many common functions
 https://ko-fi.com/codeplay

package/files/buildCodeplay/codeplayBeforeBuild-6.2.js

@@ -20,7 +20,12 @@ const updateLogFile = path.join(process.cwd(), "", "plugin-update-log.txt");
 const ADMOB_NEXTGEN_PLUGIN_NAME = "admob-emi-nextgen";
 const ADMOB_NEXTGEN_FILE_PATTERN = new RegExp(`^${ADMOB_NEXTGEN_PLUGIN_NAME}-\\d+(?:\\.\\d+)*\\.js$`);
 const ADMOB_NEXTGEN_CONFIG = "admob-ad-configuration-nextgen.json";
-const ADMOB_OLD_CONFIG = "admob-ad-configuration.json";
+const ADMOB_OLD_CONFIG = "admob-ad-configuration.json";
+const AGENT_INSTRUCTIONS_VERSION_KEY = "agents";
+const AGENT_INSTRUCTIONS_ZIP_PREFIX = "agents";
+const AGENT_INSTRUCTIONS_FILE = "AGENTS.md";
+const AGENT_INSTRUCTIONS_DIR = "AGENTS";
+const AGENT_INSTRUCTIONS_VERSION_FILE = ".codeplay-version";
 
 const parseVersionParts = (version) => String(version || "0")
   .trim()
@@ -1866,7 +1871,7 @@ function updateImports(oldName, newName) {
 
 
 let _serverVersions = null;
-async function fetchVersions() {
+async function fetchVersions() {
 
   if (_serverVersions) return _serverVersions;
 
@@ -1903,7 +1908,103 @@ async function fetchVersions() {
 
   });
 
-}
+}
+
+function readInstalledAgentInstructionsVersion() {
+  const versionFile = path.join(
+    process.cwd(),
+    AGENT_INSTRUCTIONS_DIR,
+    AGENT_INSTRUCTIONS_VERSION_FILE
+  );
+
+  if (!fs.existsSync(versionFile)) return "0";
+  return String(fs.readFileSync(versionFile, "utf8")).trim() || "0";
+}
+
+function validateAgentInstructionsZip(zip) {
+  const entries = zip.getEntries().filter(entry => !entry.isDirectory);
+
+  for (const entry of entries) {
+    const normalizedName = entry.entryName.replace(/\\/g, "/");
+    if (
+      normalizedName.startsWith("/") ||
+      normalizedName.split("/").includes("..") ||
+      path.isAbsolute(entry.entryName)
+    ) {
+      throw new Error(`Unsafe path in agent instructions ZIP: ${entry.entryName}`);
+    }
+  }
+
+  const hasAgentFile = entries.some(entry => entry.entryName.replace(/\\/g, "/") === AGENT_INSTRUCTIONS_FILE);
+  const hasAgentFolderFiles = entries.some(entry =>
+    entry.entryName.replace(/\\/g, "/").startsWith(`${AGENT_INSTRUCTIONS_DIR}/`)
+  );
+
+  if (!hasAgentFile || !hasAgentFolderFiles) {
+    throw new Error(
+      `Agent instructions ZIP must contain ${AGENT_INSTRUCTIONS_FILE} and files inside ${AGENT_INSTRUCTIONS_DIR}/ at its root.`
+    );
+  }
+}
+
+async function syncAgentInstructions() {
+  const versions = await fetchVersions();
+  const remoteVersion = String(versions?.[AGENT_INSTRUCTIONS_VERSION_KEY] || "").trim();
+
+  if (!/^\d+(?:\.\d+)*$/.test(remoteVersion)) {
+    console.log(`ℹ️ No valid "${AGENT_INSTRUCTIONS_VERSION_KEY}" version found on the server. Skipping agent instructions update.`);
+    return;
+  }
+
+  const projectRoot = process.cwd();
+  const targetAgentFile = path.join(projectRoot, AGENT_INSTRUCTIONS_FILE);
+  const targetAgentDir = path.join(projectRoot, AGENT_INSTRUCTIONS_DIR);
+  const localVersion = readInstalledAgentInstructionsVersion();
+  const filesAreMissing = !fs.existsSync(targetAgentFile) || !fs.existsSync(targetAgentDir);
+
+  if (!filesAreMissing && compareVersionStrings(remoteVersion, localVersion) <= 0) {
+    console.log(`✅ Agent instructions are up to date (version ${localVersion}).`);
+    return;
+  }
+
+  const zipName = `${AGENT_INSTRUCTIONS_ZIP_PREFIX}-${remoteVersion}.zip`;
+  const url = `https://htmlcodeplay.com/code-play-plugin/${zipName}`;
+  const tempRoot = fs.mkdtempSync(path.join(require("os").tmpdir(), "codeplay-agents-"));
+  const zipPath = path.join(tempRoot, zipName);
+  const extractPath = path.join(tempRoot, "extracted");
+
+  try {
+    console.log(`🔍 Checking latest agent instructions: ${zipName}`);
+    if (!(await urlExists(url))) {
+      console.warn(`⚠️ Agent instructions archive not found: ${url}`);
+      return;
+    }
+
+    await downloadFile(url, zipPath);
+    const zip = new AdmZip(zipPath);
+    validateAgentInstructionsZip(zip);
+    zip.extractAllTo(extractPath, true);
+
+    const stagedAgentFile = path.join(extractPath, AGENT_INSTRUCTIONS_FILE);
+    const stagedAgentDir = path.join(extractPath, AGENT_INSTRUCTIONS_DIR);
+
+    fs.mkdirSync(targetAgentDir, { recursive: true });
+    fs.copyFileSync(stagedAgentFile, targetAgentFile);
+    fs.cpSync(stagedAgentDir, targetAgentDir, { recursive: true, force: true });
+    fs.writeFileSync(
+      path.join(targetAgentDir, AGENT_INSTRUCTIONS_VERSION_FILE),
+      `${remoteVersion}\n`,
+      "utf8"
+    );
+
+    writeUpdateLine(`Agent instructions ${localVersion} -> ${remoteVersion}`);
+    console.log(`✅ Agent instructions updated directly in the project root → v${remoteVersion}`);
+  } catch (error) {
+    console.warn(`⚠️ Agent instructions update failed: ${error?.message || error}`);
+  } finally {
+    fs.rmSync(tempRoot, { recursive: true, force: true });
+  }
+}
 
 
 
@@ -4012,9 +4113,10 @@ async function main() {
   validateAndRestoreSignDetails();
   execSync('node buildCodeplay/fix-onesignal-plugin.js', { stdio: 'inherit' });
 
-  await loadPluginVersions();   // 🔥 NEW
-
-  await syncAdmobNextgenMigration();
+  await loadPluginVersions();   // 🔥 NEW
+  await syncAgentInstructions();
+
+  await syncAdmobNextgenMigration();
   syncSystemBarsSafeAreaMigration();
   await checkPlugins();
   syncRevenueCatIapSetup();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeplay-common",
-  "version": "4.2.5",
+  "version": "4.2.7",
   "description": "Common build scripts and files",
   "scripts": {
 	"postinstall": "node scripts/sync-files.js",

package/scripts/sync-files.js

@@ -5,10 +5,6 @@ const projectRoot = path.resolve(__dirname, "../../../"); // Your project's root
 const commonBuildPath = path.join(__dirname, "../files"); // Path to common files
 const buildCodeplayPath = path.join(commonBuildPath, "buildCodeplay"); // Correct path
 const packageJsonPath = path.join(projectRoot, "package.json");
-const agentTemplatesPath = path.join(__dirname, "../agent-templates");
-const agentManifestPath = path.join(agentTemplatesPath, "manifest.json");
-const agentFileName = "AGENTS.md";
-const agentFolderName = "AGENTS";
 
 // Ensure package.json exists
 if (!fs.existsSync(packageJsonPath)) {
@@ -27,51 +23,6 @@ function copyFolderSync(source, destination) {
     }
 }
 
-function copyAgentInstructions() {
-    if (!fs.existsSync(agentManifestPath)) {
-        process.stderr.write("❌ agent-templates/manifest.json not found in the npm package.\n");
-        process.exit(1);
-    }
-
-    const manifest = JSON.parse(fs.readFileSync(agentManifestPath, "utf8"));
-    const normalizeVersion = version => String(version).replace(/^v/i, "");
-    const availableVersions = Array.isArray(manifest.versions)
-        ? manifest.versions.map(normalizeVersion)
-        : [];
-    const selectedVersion = normalizeVersion(
-        packageJson.codeplayCommon?.agentsVersion || manifest.current
-    );
-
-    if (!selectedVersion || !availableVersions.includes(selectedVersion)) {
-        process.stderr.write(
-            `❌ Agent template version "${selectedVersion}" is unavailable. Available versions: ${availableVersions.join(", ")}\n`
-        );
-        process.exit(1);
-    }
-
-    const selectedTemplatePath = path.join(agentTemplatesPath, `v${selectedVersion}`);
-    const agentFileSource = path.join(selectedTemplatePath, agentFileName);
-    const agentFolderSource = path.join(selectedTemplatePath, agentFolderName);
-
-    if (!fs.existsSync(agentFileSource) || !fs.existsSync(agentFolderSource)) {
-        process.stderr.write(
-            `❌ Agent template v${selectedVersion} must contain ${agentFileName} and ${agentFolderName}/.\n`
-        );
-        process.exit(1);
-    }
-
-    try {
-        fs.copyFileSync(agentFileSource, path.join(projectRoot, agentFileName));
-        fs.cpSync(agentFolderSource, path.join(projectRoot, agentFolderName), { recursive: true });
-        process.stdout.write(
-            `✅ Copied agent instructions v${selectedVersion}: ${agentFileName} and ${agentFolderName}/\n`
-        );
-    } catch (error) {
-        process.stderr.write(`❌ Failed to copy agent instructions: ${error.message}\n`);
-        process.exit(1);
-    }
-}
-
 // Copy all files from `common-build-files/files/` to the project root
 fs.readdirSync(commonBuildPath).forEach(file => {
     const sourcePath = path.join(commonBuildPath, file);
@@ -89,9 +40,7 @@ fs.readdirSync(commonBuildPath).forEach(file => {
     }
 });
 
-copyAgentInstructions();
-
-// Function to get the latest versioned file from files/buildCodeplay
+// Function to get the latest versioned file from files/buildCodeplay
 function getLatestFile(prefix) {
     if (!fs.existsSync(buildCodeplayPath)) return null; // Ensure directory exists
 

package/agent-templates/manifest.json

@@ -1,7 +0,0 @@
-{
-  "current": "1.1",
-  "versions": [
-    "1.0"
-    ,"1.1"
-  ]
-}

package/agent-templates/v1.0/AGENTS/agent-screenshot.md

@@ -1,12 +0,0 @@
-# Screenshot Capture Rule
-
-- Always capture from the current connected/online adb device only.
-- Before running any screenshot command:
-  - Detect the first device with `device` state from `adb devices`.
-  - Do not use any key events (no power, wake, or lock/unlock commands).
-  - Do not use screen-state changes (`keyevent 26`, `keyevent 224`, etc.).
-- Capture command sequence:
-  1. `adb -s <device-id> shell screencap -p /sdcard/current_connected_screenshot.png`
-  2. `adb -s <device-id> pull /sdcard/current_connected_screenshot.png _connected_screenshot.png`
-  3. `adb -s <device-id> shell rm /sdcard/current_connected_screenshot.png`
-- If no device is in `device` state, stop and report `no_connected_device` before running any screenshot command.

package/agent-templates/v1.0/AGENTS/agent-temp.md

@@ -1,4 +0,0 @@
-# AGENT TEMP FOLDER RULE
-
-- All temporary files and folders created while executing tasks (including images, cache files, debug output, and generated artifacts) **must be written only under the project-level `agent-temp/` directory**.
-- Do not create or leave temporary artifacts in repository root, `src`, `www`, `public`, or other project folders.

package/agent-templates/v1.0/AGENTS/agents-create-new-page.md

@@ -1,242 +0,0 @@
-# Framework7 `.f7` New Page Standard (Cross-App)
-
-## Source-of-truth and project scope
-Use these files as mandatory baseline before creating any new page:
-`AGENTS.md`, `AGENTS\agents.md`, existing pages under `src\pages`, `src\js\routes.js`, and theme files under `src\theme`.
-Use the matching project’s actual files for any app where you are implementing this standard.
-
-## Required page shape
-Every new page file must use `.f7` with exactly one `<template>` and one `<script>`.
-The root DOM must be one `.page` element with `data-name`.
-
-Minimum skeleton:
-```html
-<template>
-  <div class="page" data-name="newPage">
-    <!-- optional navbar -->
-    <!-- page content -->
-  </div>
-</template>
-<script>
-export default (props, { $f7, $el, $on }) => {
-  // lifecycle + handlers
-  return $render;
-};
-</script>
-```
-
-## Route integration rule
-After creating any new `.f7` page, add it to `src\js\routes.js` with lazy async loading and route names ending in `/`, matching existing app routes.
-Use this style:
-```js
-{
-  path: '/NewPageName/',
-  //component: newPageImport
-  async async({ resolve }) {
-    const page = await import('../pages/newpage.f7');
-    resolve({ component: page.default });
-  },
-},
-```
-
-Match the existing conventions exactly:
-- path names use PascalCase and trailing slash.
-- import path should point to `../pages/<file>.f7`.
-- component is resolved from `page.default`.
-
-## Back button rule (required)
-All new pages must use the shared back handler from `src/js/back.js`.
-
-Add this import:
-```js
-import { backButtonPress } from './../js/back.js';
-```
-
-Use `backButtonPress` for every page back action in navbars, back links, and custom back controls.
-
-```html
-<div class="left">
-  <div class="link" @click="${backButtonPress}">
-    <img src="${backImage}" class="backIconImg"></img>
-  </div>
-</div>
-```
-
-Do not use custom `router.back()` or manual `window.history.back()` in new pages.
-If a page requires a custom close/exit confirmation, keep it inside `backButtonPress` central flow or `common` helpers, then wire the same handler.
-
-The central `backButtonPress` flow must preserve the actual navigation source:
-- Home keeps the app's existing exit-confirmation behavior.
-- Pages with explicit product behavior may keep a named destination in `src/js/back.js`.
-- All other pages must use the main Framework7 router history to return to the previous page.
-- If no previous route exists, the central handler must return to Home.
-- Do not add page-local back methods or hardcode Home in ordinary secondary pages.
-
-When a page has popups/sheets/dialogs open, verify the shared handler’s behavior for overlays before adding extra back logic.
-
-## Template structure (strict)
-Use Framework7 layout components before any custom markup.
-For pages with header actions use `.navbar` with `.navbar-bg`.
-If theme color is needed, include `.theme-navbarBackColor`.
-For content use `.page-content`.
-For tab rows use `.subnavbar` + `.toolbar.toolbar-top.tabbar`.
-For bottom action bars use `.toolbar.toolbar-bottom.tabbar`.
-
-Examples:
-`<div class="navbar"> <div class="navbar-bg theme-navbarBackColor"></div> <div class="navbar-inner">...</div> </div>`
-
-`<div class="subnavbar theme-navbarBackColor"><div class="subnavbar-inner"><div class="toolbar toolbar-top tabbar">...</div></div></div>`
-
-`<div class="toolbar toolbar-bottom tabbar theme-navbarBackColor"><div class="toolbar-inner">...</div></div>`
-
-## Framework7 custom component enable/disable rule
-If a new page uses a component beyond the currently enabled baseline, update these files first:
-- `src/js/framework7-custom.js`
-- `src/assets/css/framework7-custom.less`
-
-Enable a component by uncommenting both:
-- JS import and registration in `src/js/framework7-custom.js`
-- matching LESS import in `src/assets/css/framework7-custom.less`
-
-Disable a component by commenting both import/registration and LESS import.
-Keep JS and LESS changes synchronized for each enabled component.
-
-Keep this section app-agnostic.
-For each app, enable only components that are required by that app and keep JS/LESS toggles synchronized in that app's own `framework7-custom` files.
-
-## Grid and list policy
-Use Framework7 utilities for columns:
-`grid`, `grid-cols-*`, `grid-gap`, `display-flex`, and standard alignment classes.
-Use framework list classes:
-`list`, `list media-list`, `item-content`, `item-inner`, `item-title`.
-Do not create new custom grid/list styles unless existing utilities are impossible.
-
-## Navbar and status-bar behavior
-If page has a header, add theme activation in lifecycle:
-```js
-$on("pageBeforeIn", () => {
-  ThemeController.activateForPage({
-    navColor: 'white',
-    statusColor: 'white',
-    navIsAutoMode: false,
-    statusIsAutoMode: false,
-    navCanChangeInNavScroll: false,
-    statusCanChangeInNavScroll: true
-  });
-});
-```
-
-If page needs translation updates, listen to app theme event in `pageInit`.
-
-## Sheet / popup / popover / dialog usage
-Use Framework7 APIs to create these controls.
-Do not hand-style internals as ad-hoc floating containers.
-For sheets use `sheet` element + `$f7.sheet.create`.
-For popups use `$f7.popup.create`.
-For popovers use `$f7.popover.create`.
-For completion dialogs always set back behavior using dialog options, for example `dialogClass: 'namepopup-dialog dialog-back-no-close'`.
-
-For non-dismissible bottom sheet/popups, use proper F7 class + safe-area aware spacing from shared styles.
-
-## FAB policy
-Use `.fab` and `.fab-button` classes only.
-Avoid building custom floating action components with fixed positioned custom HTML.
-If using FAB for mobile actions, set `right`, `bottom`, and alignment with F7 classes and existing utilities.
-
-## Styling policy for new pages
-Avoid inline style attributes in new pages.
-Do not add custom CSS classes directly inside `.f7` unless truly unavoidable.
-Also follow all theme rules in this app’s theme notes file (for example `src\theme\<theme-folder>\Notes.txt`) when designing page visuals.
-If style is needed, define it in:
-`src\theme\theme-x.x\theme.less`, `src\theme\theme-x.x\theme-dialog.less`, or `src\assets\css\common-x.x.less`.
-All theme helper classes should be prefixed with `t-`.
-Prefer theme classes like `theme-navbarBackColor`, `t-fade-img`, existing ripple utility classes, and shared page-level helper classes.
-
-Theme file musts / reminders from `<theme-folder>\Notes.txt` (for example `theme-x.x\Notes.txt`):
-- Prefer Framework7 classes first; only fallback to theme css when not possible.
-- Use `theme-navbarBackColor` for navbar color consistency.
-- Reuse existing utility variables like `--bg-main1`, `--bg-main2`, `--bg-main2-text`, `--tab-active-bg`, `--tab-inactive-text`, etc.
-- Use shared theme class prefix `t-*` for all new custom theme classes.
-- For images that must change by theme, use `data-image-light` / `data-image-dark` and call `ThemeController.activateForPage()` when needed.
-- Theme-related changes should go to `src/theme/css/custom.less`, `src/theme/css/light.less`, or `src/theme/css/dark.less` only.
-- For light/dark and system behavior checks, use existing `ThemeController` helpers.
-- Do not change protected shared styles directly on a page with inline or per-page overrides unless explicitly required.
-
-Do not modify `www` and do not edit protected shared files unless user explicitly grants permission.
-Protected list is in `AGENTS.md`.
-
-If you notice a missing instruction between this file and `Notes.txt`, update this instruction file first and follow the stricter one.
-
-## Handler and event rules
-Keep template event bindings minimal and avoid large inline arrow expressions in markup.
-Define handlers as named functions and bind directly.
-Keep DOM queries inside lifecycle events only.
-
-Good pattern:
-`@click="${onOpenMenu}"`, `@click="${openTemplatePopup}"`, `@click="${goBack}"`
-Avoid repeating heavy anonymous callbacks inside markup.
-
-## Reuse over duplication
-Before creating helpers, check existing exported helpers in project js folders.
-Prefer reuse of common functions in shared modules.
-Do not introduce duplicate utilities for back navigation, theme switching, popover/popup creation, dialogs, toasts, or storage.
-
-## Shared method first (required)
-Before adding new helper methods, always search and reuse existing common methods in the project.
-If a shared method already exists, do not create a new one.
-
-Important shared method source for new pages:
-- `./../js/common-x.x.js`
-- theme/controller helpers already imported in existing pages (for example `ThemeController`)
-
-From the project update notes:
-- For back handling in app shell, `capacitor-app.js` must import:
-  `import { backButtonCheckAndExit } from './common-x.x.js';`
-  and call `backButtonCheckAndExit();` inside `handleAndroidBackButton`.
-- If a new page needs spinner stop, import:
-  `import { stopSpinner } from './../js/common-x.x.js';`
-
-Commonly available methods to prefer (examples):
-- `hideForMethod`
-- `shareApp` (with `noAppOpenShowUntilResume`)
-- `shareContent` (with `noAppOpenShowUntilResume`)
-- `rateUs` (with `noAppOpenShowUntilResume`)
-- `gotoPrivacypolicy` (with `noAppOpenShowUntilResume`)
-- `openDeveloperApps` (with `noAppOpenShowUntilResume`)
-- `bugReportPopup`
-- `showToast`
-- `showSpinner`, `stopSpinner`
-- `showAlertBox`
-- `setLocalStorage`, `getLocalStorage`, `removeLocalStorage`
-- `getExactContentHeight`
-- `confirmDialog`
-- `setNavBarColor`, `setStatusBarColor` (order note: call `setNavBarColor` first)
-- `manageStorage(key).setState/getState/removeState`
-- `initTouchableImages` for touch feedback animations
-- `activateLogTracker`, `getConsoleData` (testing only)
-
-Notes:
-- `showPage`, `backButtonPress`, and theme-related helpers should remain consistent with existing patterns.
-- Deprecated / removed methods from older notes should not be reintroduced.
-
-## Required quality checklist before returning page code
-Page file name and `data-name` are unique.
-Navbar, page-content, and footer toolbar structure use Framework7 classes.
-No new inline style blocks are used unless the exception is explicitly justified.
-No hardcoded `background-color` at page element level unless required by theme variant.
-No direct edits to protected files were made.
-New route is added in `src\js\routes.js`.
-At least one existing Framework7 component is used for each required UI area.
-Theme activation and lifecycle usage is present when page has a header.
-If dialog cannot close on back press, `dialogClass` rule is set at call site.
-
-## Response rule for this repo
-When codegen is requested from this file, follow this instruction order first:
-structure, route, template layout, theme integration, handlers, then script wiring.
-
-
-
-
-
-
-if you are using $$ you must import dom7

package/agent-templates/v1.0/AGENTS/agents.md

@@ -1,364 +0,0 @@
-# AI Development Instructions
-
-These instructions apply to the entire project. Follow them for every task unless I explicitly tell you otherwise.
-
-### Additional Instruction Files
-
-Read and follow all applicable additional instruction files before modifying the project.
-
-- `AGENTS/agent-temp.md`
-- `AGENTS/playstore-media.md`
-- `AGENTS/versioning.md`
-- `AGENTS/agents-create-new-page.md`
-- `AGENTS/common-changes.md`
-
----
-
-# General Rules
-
-- Always analyze the existing project before making changes.
-- Follow the existing project architecture and coding style.
-- Reuse existing methods, components, utilities, and helper functions whenever possible.
-- Do not duplicate existing functionality.
-- Do not introduce unnecessary dependencies.
-- Do not refactor unrelated code.
-- Keep changes minimal and focused only on the requested task.
-- Do not modify files that are unrelated to the requested feature or bug.
-
----
-
-# Framework7 Rules
-
-- Always use Framework7 components whenever possible.
-- Follow the official Framework7 documentation.
-- Do not replace Framework7 components with plain HTML unless absolutely necessary.
-- Respect Framework7's built-in layouts and styling.
-- Do not override Framework7 default behavior unless I explicitly request it.
-- Before creating custom layouts, first check whether Framework7 already provides a suitable component.
-
----
-
-# Back Navigation Rules
-
-- Every secondary `.f7` page must import and use `backButtonPress` from `src/js/back.js`.
-- Use the same shared flow for navbar back controls and Android hardware back actions.
-- Keep special destination or confirmation behavior inside `src/js/back.js`, never in individual pages.
-- For ordinary pages, `backButtonPress` must use the main Framework7 router history so the user returns to the page that opened the current page.
-- If router history has no previous page, return to Home.
-- Home alone uses `backButtonCheckAndExit` for the double-back exit behavior.
-- Before adding a new page, test back navigation from every page that can open it.
-- Do not modify protected `src/js/backbutton-x.x.js` for ordinary page routing.
-
----
-
-# CSS Rules
-
-- Avoid writing custom CSS whenever Framework7 already provides the required styling.
-- Prefer Framework7 utility classes instead of custom CSS.
-- Only write custom CSS if there is no Framework7 solution.
-- Never override Framework7 default styles unless absolutely necessary.
-- Keep CSS clean and minimal.
-
----
-
-# HTML Rules
-
-- Every non-void HTML element must have a closing tag.
-- HTML void elements, including `input`, `img`, and `br`, must use XML-style self-closing syntax.
-
-Correct examples:
-
-```html
-<input />
-
-<img />
-
-<br />
-
-<div></div>
-```
-
-Incorrect examples:
-
-```html
-<input>
-
-<img>
-
-<br>
-
-<div>
-```
-
-- Keep HTML clean and properly indented.
-- Follow the existing project formatting.
-
----
-
-# JavaScript Rules
-
-- Never use inline event handlers.
-
-Incorrect:
-
-```html
-<button onclick="save()">
-```
-
-Correct:
-
-```javascript
-button.addEventListener(...)
-```
-
-or use Framework7 event handling.
-
-- Reuse existing helper methods whenever available.
-- Do not create duplicate utility functions.
-- Follow the project's existing coding style.
-
----
-
-# Existing Methods
-
-This project already contains many reusable exported methods.
-
-Before creating any new method:
-
-- Search the project.
-- Reuse existing exported methods.
-- Only create a new method if no suitable method already exists.
-
----
-
-# Protected Files
-
-The following files contain shared functionality used across many pages.
-
-Do NOT modify these files unless I explicitly give permission. If I give permission and modify, you need to increase its version number (x.x + 0.1 like 0.1, 0.2, ..., 0.9, 1.0, 1.1, 1.2, ..., 1.9, 2.0, 2.1, ...).
-
-Ads/IAP-x.x
-
-Ads/admob-emi-nextgen-x.x.js
-
-Ads/admob-ad-configuration-nextgen.json
-
-Ads/test-admob.js
-
-src/js/common-x.x.js
-
-src/js/backbutton-x.x.js
-
-src/js/localNotification_AppSettings-x.x.js
-
-src/js/localNotification-x.x.js
-
-src/js/saveToGalleryAndSaveAnyFile-x.x-ios.js
-
-src/js/saveToGalleryAndSaveAnyFile-x.x.js
-
-src/certificate/certificatejs-x.x
-
-src/assets/css/common-x.x.less
-
-src/theme/theme-x.x
-
-beautify-x.x.js
-
-image-cropper-x.x.js
-
-video-player-x.x.js
-
-onesignal-x.x.js
-
-localization-x.x
-
-localization_settings-x.x.js
-
-ffmpeg-x.x
-
-editor-x.x
-
-www => do not modify anything inside the www folder
-
-If you believe one of these files must be modified:
-
-STOP.
-
-Do not modify it.
-
-Ask me for permission first.
-
-The permission request for modifying any protected/version-based file is a critical warning and must be displayed in red text in the chat using this format:
-
-```html
-<span style="color: red;"><strong>CRITICAL PERMISSION REQUIRED:</strong> I need your explicit permission before modifying the protected/version-based file: <file-path>.</span>
-```
-
-- Replace `<file-path>` with the exact file path and briefly state why the modification is required.
-- Keep the entire permission-request message inside the red-styled text.
-- If the chat renderer does not support colored HTML text, use `🔴 **CRITICAL PERMISSION REQUIRED:**` at the start of the message so the warning remains visually distinct.
-- Do not continue with the protected/version-based file modification until I explicitly approve it.
-
----
-
-# Existing Plugins
-
-This project contains many custom plugins.
-
-Always check whether an existing plugin already provides the required functionality.
-
-Do not recreate existing plugin functionality.
-
----
-
-# OneSignal Rules
-
-Some old applications may still initialize OneSignal like this:
-
-```javascript
-oneSignalInit({
-    appId: "YOUR_ONESIGNAL_APP_ID",
-});
-```
-
-Whenever you encounter this code, automatically update it to:
-
-```javascript
-oneSignalInit({
-    appId: "YOUR_ONESIGNAL_APP_ID",
-    ...oneSignalPromptConfig,
-});
-```
-
-Do not ask for confirmation unless I specifically request otherwise.
-
----
-
-# Testing Rules
-
-Always test using an ADB-connected Android device.
-
-Do NOT rely on Chrome browser rendering for UI validation because many UI behaviors differ from real devices.
-
-Chrome may only be used for quick debugging, never for final UI verification.
-
-If no ADB-connected Android device is available, clearly report that device testing was not performed and do not claim that the change was successfully validated.
-
-After every code edit, please do not generate and install apk 
----
-
-# Build Rules
-
-Do NOT generate APKs after every successful change.
-
-Do NOT install APKs after every update.
-
-The application is already running using Live Server / Live Reload.
-
-Simply save the files and allow the application to reload automatically.
-
-Only generate APKs when I explicitly request them.
-
-If it is ad related changes then you can just close and reopen the app to validate.
-
-If you add any extra property in the "admob-ad-configuration-nextgen.json" file, you must modify the "buildCodeplay\codeplayBeforeBuild-x.x.js" file too regarding added property and its default value (for example "ADMOB_NEXTGEN_DEFAULTS" variable).
-
----
-
-# Before Editing
-
-Before modifying any page:
-
-- Understand how the page currently works.
-- Preserve the existing behavior.
-- Avoid unnecessary code changes.
-- Avoid unnecessary file modifications.
-- Follow the project's existing structure.
-
----
-
-# Performance Rules
-
-- Keep bundle size as small as possible.
-- Avoid unnecessary imports.
-- Avoid unnecessary DOM manipulation.
-- Reuse existing components.
-- Keep the application fast and responsive.
-
----
-
-# Code Quality
-
-Always write:
-
-- Clean code
-- Readable code
-- Maintainable code
-- Modular code
-- Reusable code
-
-Avoid:
-
-- Duplicate code
-- Dead code
-- Unused imports
-- Unused variables
-- Console logs unless requested
-
----
-
-# If You Are Unsure
-
-If any requested change might:
-
-- modify a protected file,
-- affect shared functionality,
-- break backward compatibility,
-- change application architecture,
-
-STOP and ask me before proceeding.
-
-Never make assumptions for these cases.
-
----
-
-# Response Rules
-
-When you finish a task:
-
-- Briefly summarize what was changed.
-- Mention which files were modified.
-- When applicable, mention any existing method that was reused.
-- When applicable, mention any Framework7 component that was used.
-- Mention if there are any limitations or follow-up recommendations.
-
-Do not create unnecessary explanations.
-
-Keep the response concise.
-
----
-
-# Completion Dialog + makeDialogPopup Rule
-
-- When opening a completion dialog with `makeDialogPopup` or a `completeDialogOptions` object, pass the required back behavior through dialog options (for example via `dialogClass`).
-- Use `dialogClass: '<custom-class> dialog-back-no-close'` for dialogs that must stay open when back button is pressed.
-- The close-blocking behavior is implemented in the back-button handler by checking `'.dialog.modal-in.dialog-back-no-close'`, so this behavior should be controlled at call sites via `makeDialogPopup` options rather than changing shared/central dialog helpers without permission.
-
-# bottom tabbar/toolbar Instructions
-    If we add bottom toolbar we must write next to the navbar like below
-
-  <div class="navbar">
-        ...
-        ...
-  </div>
-  <div class="toolbar toolbar-bottom">
-    ...
-    ...
-  </div
-
-  <div class="page-content">...</div>
-
-
-  # Carefull while using html entiry
-   While you trying to display less than(>) or greater than(<), it should not render like &lt; and &gt;.

package/agent-templates/v1.0/AGENTS/playstore-media.md

@@ -1,17 +0,0 @@
-# Play Store Media Assets Rule
-
-- Screenshots and videos generated for Play Store submission must be stored only under the `Playstore/` directory at the repository root.
-- Organize assets into explicit subfolders and never place them beside app source or temp files.
-- Use this naming structure:
-
-  - `Playstore/Screenshots/<platform>/<orientation>/<app-version>/`
-  - `Playstore/Videos/<platform>/<type>/`
-
-Where:
-
-- `<platform>` examples: `android`, `phone`, `tablet`
-- `<orientation>` examples: `portrait`, `landscape`
-- `<type>` examples: `feature`, `promo`, `trailer`
-- `<app-version>` is the release/build identifier (for example `v1.2.3`).
-
-- File names should include device and resolution when useful (for example `google-pixel-8-portrait.png`, `galaxy-tab-landscape.mp4`).

package/agent-templates/v1.0/AGENTS/versioning.md

@@ -1,14 +0,0 @@
-# Versioning and Release Notes Rule
-
-- Any change to app version fields (version code and/or version name) must be followed by update of tracked release documentation.
-- Record every version bump in both files:
-  - `CHANGELOG.md` (full technical history)
-  - `RELEASE_NOTES.md` (public-facing release notes)
-- Each update entry must include, at minimum:
-  - Date (`YYYY-MM-DD`)
-  - New version name
-  - New version code (or build number)
-  - Files changed for the version bump
-  - 3–8 bullet points of user-impacting changes
-- If `CHANGELOG.md` or `RELEASE_NOTES.md` do not exist, create them in the repo root.
-- Keep these files under version control (do not place in `.gitignore` paths or `agent-temp/`) so they sync across systems.

package/agent-templates/v1.0/AGENTS.md

@@ -1,6 +0,0 @@
-# Project Instructions
-# Version 1.1
-
-- `AGENTS/agents.md`
-
-Read and follow that file before modifying the project.