@adminforth/auto-remove 1.0.10 → 1.0.11

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import { AdminForthPlugin } from "adminforth";
+import type { IAdminForth, IHttpServer, AdminForthResource } from "adminforth";
+import type { PluginOptions } from './types.js';
+export default class AutoRemovePlugin extends AdminForthPlugin {
+    options: PluginOptions;
+    resource?: AdminForthResource;
+    timer?: NodeJS.Timeout;
+    constructor(options: PluginOptions);
+    instanceUniqueRepresentation(pluginOptions: any): string;
+    modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource): Promise<void>;
+    validateConfigAfterDiscover(adminforth: IAdminForth, resourceConfig: AdminForthResource): void;
+    private runCleanup;
+    private cleanupByCount;
+    private cleanupByTime;
+    setupEndpoints(server: IHttpServer): void;
+}

package/dist/types.d.ts

@@ -0,0 +1,45 @@
+import { type PluginsCommonOptions } from "adminforth";
+export type AutoRemoveMode = 'count-based' | 'time-based';
+/**
+ * count-based 100, 1k, 1kk, 1m
+ */
+export type HumanNumber = string;
+/**
+ * s
+ * min
+ * h
+ * d
+ * w
+ * mon
+ * y
+ */
+export type HumanDuration = string;
+export interface PluginOptions extends PluginsCommonOptions {
+    createdAtField: string;
+    /**
+     * - count-based: Delete items > maxItems
+     * - time-based: Delete age > maxAge
+     */
+    mode: AutoRemoveMode;
+    /**
+     * for count-based mode (100', '1k', '10k', '1m')
+     */
+    keepAtLeast?: HumanNumber;
+    /**
+     * Minimum number of items to always keep in count-based mode.
+     * This acts as a safety threshold together with `keepAtLeast`.
+     * Example formats: '100', '1k', '10k', '1m'.
+     *
+     * Validation ensures that minItemsKeep <= keepAtLeast.
+    */
+    minItemsKeep?: HumanNumber;
+    /**
+     * Max age of item for time-based mode ('1d', '7d', '1mo', '1y')
+     */
+    deleteOlderThan?: HumanDuration;
+    /**
+     * Interval for running cleanup (e.g. '1h', '1d')
+     * Default '1d'
+     */
+    interval?: HumanDuration;
+}

package/dist/utils/parseDuration.d.ts

@@ -0,0 +1 @@
+export declare function parseDuration(value: string): number;

package/dist/utils/parseNumber.d.ts

@@ -0,0 +1 @@
+export declare function parseHumanNumber(value: string): number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/auto-remove",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",

package/tsconfig.json

@@ -2,6 +2,7 @@
     "compilerOptions": {
       "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include*/ 
       "module": "node16",                                /* Specify what module code is generated. */
+    "declaration": true,
       "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
       "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules.  */
       "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */