strapi-plugin-field-clearer 1.0.0

package/dist/server/src/bootstrap.d.ts

@@ -0,0 +1,5 @@
+import type { Core } from '@strapi/strapi';
+declare const bootstrap: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => void;
+export default bootstrap;

package/dist/server/src/config/index.d.ts

@@ -0,0 +1,9 @@
+declare const _default: {
+    default: {
+        allowedContentTypes: string[];
+    };
+    validator(config: {
+        allowedContentTypes?: unknown;
+    }): void;
+};
+export default _default;

package/dist/server/src/content-types/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/dist/server/src/controllers/controller.d.ts

@@ -0,0 +1,28 @@
+import type { Core } from '@strapi/strapi';
+declare const controller: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => {
+    /**
+     * Get plugin configuration for admin UI
+     * GET /field-clearer/config
+     */
+    getConfig(ctx: any): Promise<any>;
+    /**
+     * Preview what will be deleted (dry run)
+     * POST /field-clearer/preview-field
+     * Body: { contentType, documentId, fieldPath }
+     */
+    previewField(ctx: any): Promise<any>;
+    /**
+     * Clear a field from a document
+     * POST /field-clearer/clear-field
+     * Body: { contentType, documentId, fieldPath }
+     *
+     * Examples:
+     * - fieldPath: "coupons" → clears all coupons
+     * - fieldPath: "coupons.freebies" → clears freebies inside each coupon
+     * - fieldPath: "coupons[1].freebies" → clears freebies from 2nd coupon only
+     */
+    clearField(ctx: any): Promise<any>;
+};
+export default controller;

package/dist/server/src/controllers/index.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+    controller: ({ strapi }: {
+        strapi: import("@strapi/types/dist/core").Strapi;
+    }) => {
+        getConfig(ctx: any): Promise<any>;
+        previewField(ctx: any): Promise<any>;
+        clearField(ctx: any): Promise<any>;
+    };
+};
+export default _default;

package/dist/server/src/destroy.d.ts

@@ -0,0 +1,5 @@
+import type { Core } from '@strapi/strapi';
+declare const destroy: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => void;
+export default destroy;

package/dist/server/src/index.d.ts

@@ -0,0 +1,115 @@
+declare const _default: {
+    register: ({ strapi }: {
+        strapi: import("@strapi/types/dist/core").Strapi;
+    }) => void;
+    bootstrap: ({ strapi }: {
+        strapi: import("@strapi/types/dist/core").Strapi;
+    }) => void;
+    destroy: ({ strapi }: {
+        strapi: import("@strapi/types/dist/core").Strapi;
+    }) => void;
+    config: {
+        default: {
+            allowedContentTypes: string[];
+        };
+        validator(config: {
+            allowedContentTypes?: unknown;
+        }): void;
+    };
+    controllers: {
+        controller: ({ strapi }: {
+            strapi: import("@strapi/types/dist/core").Strapi;
+        }) => {
+            getConfig(ctx: any): Promise<any>;
+            previewField(ctx: any): Promise<any>;
+            clearField(ctx: any): Promise<any>;
+        };
+    };
+    routes: {
+        method: string;
+        path: string;
+        handler: string;
+        config: {
+            policies: string[];
+        };
+    }[];
+    services: {
+        service: ({ strapi }: {
+            strapi: import("@strapi/types/dist/core").Strapi;
+        }) => {
+            previewField(contentType: string, documentId: string, fieldPath: string): Promise<{
+                fieldPath: string;
+                fieldType: string;
+                isEmpty: boolean;
+                itemCount: number;
+                items: any[];
+                message: string;
+            }>;
+            previewTopLevelField(contentType: string, documentId: string, fieldName: string): Promise<{
+                fieldPath: string;
+                fieldType: string;
+                isEmpty: boolean;
+                itemCount: number;
+                items: any[];
+                message: string;
+            }>;
+            previewNestedField(contentType: string, documentId: string, componentField: string, nestedField: string, indices?: number[]): Promise<{
+                fieldPath: string;
+                fieldType: string;
+                isEmpty: boolean;
+                itemCount: number;
+                items: any[];
+                message: string;
+                componentCount?: undefined;
+                totalComponentCount?: undefined;
+                targetIndices?: undefined;
+            } | {
+                fieldPath: string;
+                fieldType: string;
+                isEmpty: boolean;
+                itemCount: number;
+                componentCount: number;
+                totalComponentCount: number;
+                targetIndices: number[];
+                items: any[];
+                message: string;
+            }>;
+            getFieldType(value: any): string;
+            extractPreviewItems(value: any, fieldName: string): any[];
+            clearField(contentType: string, documentId: string, fieldPath: string): Promise<{
+                message: string;
+                clearedCount: number;
+                path?: undefined;
+            } | {
+                message: string;
+                clearedCount: number;
+                path: string;
+            }>;
+            clearTopLevelField(contentType: string, documentId: string, fieldName: string): Promise<{
+                message: string;
+                clearedCount: number;
+                path?: undefined;
+            } | {
+                message: string;
+                clearedCount: number;
+                path: string;
+            }>;
+            clearNestedField(contentType: string, documentId: string, componentField: string, nestedField: string, indices?: number[]): Promise<{
+                message: string;
+                clearedCount: number;
+                path?: undefined;
+            } | {
+                message: string;
+                clearedCount: number;
+                path: string;
+            }>;
+            isFieldEmpty(value: any): boolean;
+            countFieldItems(value: any): number;
+            getEmptyValue(value: any): any;
+        };
+    };
+    contentTypes: {};
+    policies: {};
+    middlewares: {};
+};
+export default _default;

package/dist/server/src/middlewares/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/dist/server/src/policies/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/dist/server/src/register.d.ts

@@ -0,0 +1,5 @@
+import type { Core } from '@strapi/strapi';
+declare const register: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => void;
+export default register;

package/dist/server/src/routes/index.d.ts

@@ -0,0 +1,9 @@
+declare const _default: {
+    method: string;
+    path: string;
+    handler: string;
+    config: {
+        policies: string[];
+    };
+}[];
+export default _default;

package/dist/server/src/services/index.d.ts

@@ -0,0 +1,76 @@
+declare const _default: {
+    service: ({ strapi }: {
+        strapi: import("@strapi/types/dist/core").Strapi;
+    }) => {
+        previewField(contentType: string, documentId: string, fieldPath: string): Promise<{
+            fieldPath: string;
+            fieldType: string;
+            isEmpty: boolean;
+            itemCount: number;
+            items: any[];
+            message: string;
+        }>;
+        previewTopLevelField(contentType: string, documentId: string, fieldName: string): Promise<{
+            fieldPath: string;
+            fieldType: string;
+            isEmpty: boolean;
+            itemCount: number;
+            items: any[];
+            message: string;
+        }>;
+        previewNestedField(contentType: string, documentId: string, componentField: string, nestedField: string, indices?: number[]): Promise<{
+            fieldPath: string;
+            fieldType: string;
+            isEmpty: boolean;
+            itemCount: number;
+            items: any[];
+            message: string;
+            componentCount?: undefined;
+            totalComponentCount?: undefined;
+            targetIndices?: undefined;
+        } | {
+            fieldPath: string;
+            fieldType: string;
+            isEmpty: boolean;
+            itemCount: number;
+            componentCount: number;
+            totalComponentCount: number;
+            targetIndices: number[];
+            items: any[];
+            message: string;
+        }>;
+        getFieldType(value: any): string;
+        extractPreviewItems(value: any, fieldName: string): any[];
+        clearField(contentType: string, documentId: string, fieldPath: string): Promise<{
+            message: string;
+            clearedCount: number;
+            path?: undefined;
+        } | {
+            message: string;
+            clearedCount: number;
+            path: string;
+        }>;
+        clearTopLevelField(contentType: string, documentId: string, fieldName: string): Promise<{
+            message: string;
+            clearedCount: number;
+            path?: undefined;
+        } | {
+            message: string;
+            clearedCount: number;
+            path: string;
+        }>;
+        clearNestedField(contentType: string, documentId: string, componentField: string, nestedField: string, indices?: number[]): Promise<{
+            message: string;
+            clearedCount: number;
+            path?: undefined;
+        } | {
+            message: string;
+            clearedCount: number;
+            path: string;
+        }>;
+        isFieldEmpty(value: any): boolean;
+        countFieldItems(value: any): number;
+        getEmptyValue(value: any): any;
+    };
+};
+export default _default;

package/dist/server/src/services/service.d.ts

@@ -0,0 +1,131 @@
+import type { Core } from '@strapi/strapi';
+declare const service: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => {
+    /**
+     * Preview what will be deleted (dry run - no actual deletion)
+     * Returns field info and items that would be deleted
+     */
+    previewField(contentType: string, documentId: string, fieldPath: string): Promise<{
+        fieldPath: string;
+        fieldType: string;
+        isEmpty: boolean;
+        itemCount: number;
+        items: any[];
+        message: string;
+    }>;
+    /**
+     * Preview a top-level field deletion
+     */
+    previewTopLevelField(contentType: string, documentId: string, fieldName: string): Promise<{
+        fieldPath: string;
+        fieldType: string;
+        isEmpty: boolean;
+        itemCount: number;
+        items: any[];
+        message: string;
+    }>;
+    /**
+     * Preview a nested field deletion
+     * @param indices - Optional array of component indices to target (0-based). If null, targets all components.
+     */
+    previewNestedField(contentType: string, documentId: string, componentField: string, nestedField: string, indices?: number[] | null): Promise<{
+        fieldPath: string;
+        fieldType: string;
+        isEmpty: boolean;
+        itemCount: number;
+        items: any[];
+        message: string;
+        componentCount?: undefined;
+        totalComponentCount?: undefined;
+        targetIndices?: undefined;
+    } | {
+        fieldPath: string;
+        fieldType: string;
+        isEmpty: boolean;
+        itemCount: number;
+        componentCount: number;
+        totalComponentCount: number;
+        targetIndices: number[];
+        items: any[];
+        message: string;
+    }>;
+    /**
+     * Get a human-readable field type
+     */
+    getFieldType(value: any): string;
+    /**
+     * Extract preview items from a field value
+     */
+    extractPreviewItems(value: any, fieldName: string): any[];
+    /**
+     * Clear a field from a document using a path
+     *
+     * Supported field types:
+     * - string, text, richtext, enumeration
+     * - integer, decimal, float
+     * - boolean
+     * - CKEditor (customField)
+     * - media (single/multiple)
+     * - relation (oneToOne, oneToMany, manyToOne, manyToMany)
+     * - component (single/repeatable)
+     *
+     * Examples:
+     * - "coupons" → clears entire coupons array (sets to [])
+     * - "coupons.freebies" → clears freebies field inside each coupon component
+     * - "all_offers_unlocked_message" → clears CKEditor field
+     *
+     * @param contentType - e.g., 'api::cart.cart'
+     * @param documentId - the document's documentId
+     * @param fieldPath - e.g., 'coupons' or 'coupons.freebies'
+     */
+    clearField(contentType: string, documentId: string, fieldPath: string): Promise<{
+        message: string;
+        clearedCount: number;
+        path?: undefined;
+    } | {
+        message: string;
+        clearedCount: number;
+        path: string;
+    }>;
+    /**
+     * Clear a top-level field (e.g., "coupons" → sets coupons to [] or null)
+     * Works for all field types: relations, components, scalars, media, CKEditor
+     */
+    clearTopLevelField(contentType: string, documentId: string, fieldName: string): Promise<{
+        message: string;
+        clearedCount: number;
+        path?: undefined;
+    } | {
+        message: string;
+        clearedCount: number;
+        path: string;
+    }>;
+    /**
+     * Clear a nested field inside component(s) (e.g., "coupons.freebies" or "coupons[1].freebies")
+     * Works for all field types inside components
+     * @param indices - Optional array of component indices to target (0-based). If null, targets all components.
+     */
+    clearNestedField(contentType: string, documentId: string, componentField: string, nestedField: string, indices?: number[] | null): Promise<{
+        message: string;
+        clearedCount: number;
+        path?: undefined;
+    } | {
+        message: string;
+        clearedCount: number;
+        path: string;
+    }>;
+    /**
+     * Check if a field value is considered empty
+     */
+    isFieldEmpty(value: any): boolean;
+    /**
+     * Count items in a field for reporting
+     */
+    countFieldItems(value: any): number;
+    /**
+     * Get the appropriate empty value based on the original value type
+     */
+    getEmptyValue(value: any): any;
+};
+export default service;

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "strapi-plugin-field-clearer",
+  "version": "1.0.0",
+  "description": "A Strapi v5 plugin to clear/delete field data from content types. Supports nested fields, component arrays, relations, and more.",
+  "keywords": [
+    "strapi",
+    "strapi-plugin",
+    "strapi-v5",
+    "field-clearer",
+    "data-management",
+    "content-management"
+  ],
+  "license": "MIT",
+  "author": "Akshay Golakiya",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/akshaygolakiya/strapi-plugin-field-clearer.git"
+  },
+  "bugs": {
+    "url": "https://github.com/akshaygolakiya/strapi-plugin-field-clearer/issues"
+  },
+  "homepage": "https://github.com/akshaygolakiya/strapi-plugin-field-clearer#readme",
+  "type": "commonjs",
+  "exports": {
+    "./package.json": "./package.json",
+    "./strapi-admin": {
+      "types": "./dist/admin/src/index.d.ts",
+      "source": "./admin/src/index.ts",
+      "import": "./dist/admin/index.mjs",
+      "require": "./dist/admin/index.js",
+      "default": "./dist/admin/index.js"
+    },
+    "./strapi-server": {
+      "types": "./dist/server/src/index.d.ts",
+      "source": "./server/src/index.ts",
+      "import": "./dist/server/index.mjs",
+      "require": "./dist/server/index.js",
+      "default": "./dist/server/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "strapi-plugin build",
+    "watch": "strapi-plugin watch",
+    "watch:link": "strapi-plugin watch:link",
+    "verify": "strapi-plugin verify",
+    "prepublishOnly": "npm run build",
+    "test:ts:front": "run -T tsc -p admin/tsconfig.json",
+    "test:ts:back": "run -T tsc -p server/tsconfig.json"
+  },
+  "dependencies": {
+    "@strapi/design-system": "^2.0.0-rc.23",
+    "@strapi/icons": "^2.0.0-rc.23"
+  },
+  "devDependencies": {
+    "@strapi/sdk-plugin": "^5.3.2",
+    "@strapi/strapi": "^5.0.0",
+    "@strapi/typescript-utils": "^5.0.0",
+    "@types/react": "^18.0.0",
+    "@types/react-dom": "^18.0.0",
+    "prettier": "^3.0.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "react-router-dom": "^6.0.0",
+    "styled-components": "^6.0.0",
+    "typescript": "^5.0.0"
+  },
+  "peerDependencies": {
+    "@strapi/strapi": "^5.0.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0"
+  },
+  "strapi": {
+    "kind": "plugin",
+    "name": "field-clearer",
+    "displayName": "Field Clearer",
+    "description": "Clear/delete field data from content types with a simple UI"
+  }
+}