@avstantso/utils-flags-decorator 1.1.0 → 1.2.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+
+## [1.2.2] - 2026-01-31
+
+### Changed
+
+- Updated `@avstantso/ts` dependency (Updated @avstantso/ts dependency (fix String, Filter))
+
+
+## [1.2.1] - 2026-01-18
+
+### Changed
+
+- Fix publishing
+
 All notable changes to this project will be documented in this file.
 
 ## [1.1.0] - 2026-01-18

package/dist/_global/_register.d.ts

@@ -0,0 +1,106 @@
+declare namespace AVStantso {
+    /**
+     * @summary Add/Remove control of entity extension by boolean fields from flags value
+     * @example
+     * export const UserFlagsDecorator = FlagsDecorator([
+     *   'system',    // = 1 << 0
+     *   'test',      // = 1 << 1
+     *   'no_login',  // = 1 << 2
+     *   'no_author', // = 1 << 3
+     *   'demo',      // = 1 << 4
+     * ]);
+     *
+     * const user = {flags: 7} // system | test | no_login
+     *
+     * function print(caption: string) {
+     *   console.log(`${caption}: %O`, {
+     *     system: user.system,
+     *     test: user.test,
+     *     no_login: user.no_login,
+     *     no_author: user.no_author,
+     *     demo: user.demo,
+     *   });
+     * }
+     *
+     * print(`Without extension`);
+     * // Outputs: Without extension
+     * // {
+     * //   system: undefined,
+     * //   test: undefined,
+     * //   no_login: undefined,
+     * //   no_author: undefined,
+     * //   demo: undefined,
+     * // }
+     *
+     * // Add properties
+     * UserFlagsDecorator.expand(user);
+     *
+     * print(`With extension`);
+     * // Outputs: With extension
+     * // {
+     * //   system: true,     // 👈 (user.flags & 1 << 0) > 0
+     * //   test: true,       // 👈 (user.flags & 1 << 1) > 0
+     * //   no_login: true,   // 👈 (user.flags & 1 << 2) > 0
+     * //   no_author: false, // 👈 (user.flags & 1 << 3) > 0
+     * //   demo: false,      // 👈 (user.flags & 1 << 4) > 0
+     * // }
+     *
+     * user.no_login = false; // ≡ user.flags = user.flags & ~4;
+     *
+     * // Remove properties
+     * UserFlagsDecorator.omit(user);
+     *
+     * print(`After omit`);
+     * // Outputs: After omit
+     * // {
+     * //   system: undefined,
+     * //   test: undefined,
+     * //   no_login: undefined,
+     * //   no_author: undefined,
+     * //   demo: undefined,
+     * // }
+     */
+    namespace FlagsDecorator {
+        type Map = {
+            [x: number]: string;
+        };
+        type Readable = boolean | (() => number);
+        type Writable = boolean | ((flags: number) => void);
+        type Options<TFlagsFieldName extends string = string> = {
+            field?: TFlagsFieldName;
+            flags?: number;
+            readable?: Readable;
+            writable?: Writable;
+        };
+    }
+    type FlagsDecorator<TMap extends FlagsDecorator.Map> = {
+        /**
+         * @summary Add properties by `Object.defineProperty` to `entity`. Mutate `entity`
+         */
+        expand<T extends object>(entity: T): T & Record<keyof TS.Structure.Reverse<TMap>, boolean>;
+        /**
+       * @summary Remove propertiyes by `delete`. Mutate `entity`
+       */
+        omit<T extends object>(entity: T): Omit<T, keyof TS.Structure.Reverse<TMap>>;
+    };
+    namespace Code {
+        /**
+         * @summary FlagsDecorator utilities
+         */
+        namespace FlagsDecorator {
+            type Overload = {
+                <TMap extends AVStantso.FlagsDecorator.Map, TFlagsFieldName extends string = 'flags'>(map: TMap, options?: AVStantso.FlagsDecorator.Options<TFlagsFieldName>): FlagsDecorator<TMap>;
+                <TMap extends AVStantso.FlagsDecorator.Map, TFlagsFieldName extends string = 'flags'>(map: TMap, field?: TFlagsFieldName): FlagsDecorator<TMap>;
+                <TMap extends AVStantso.FlagsDecorator.Map>(map: TMap, flags: number): FlagsDecorator<TMap>;
+                is<TMap extends AVStantso.FlagsDecorator.Map = AVStantso.FlagsDecorator.Map>(candidate: unknown): candidate is FlagsDecorator<TMap>;
+            };
+        }
+    }
+    interface Code {
+        /**
+         * @summary FlagsDecorator utilities
+         */
+        FlagsDecorator: Code.FlagsDecorator.Overload;
+    }
+    const FlagsDecorator: Code.FlagsDecorator.Overload;
+}

package/dist/_global/index.d.ts

@@ -0,0 +1 @@
+import './_register';

package/dist/export.d.ts

@@ -0,0 +1,2 @@
+import FlagsDecorator = AVStantso.FlagsDecorator;
+export { FlagsDecorator };

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import '@avstantso/errors';
+import '@avstantso/js';
+import './_global';
+export * from './export';

package/dist/index.js

@@ -0,0 +1,66 @@
+'use strict';
+
+require('@avstantso/errors');
+require('@avstantso/js');
+
+var AVStantso$1;
+(function (AVStantso) {
+    AVStantso.FlagsDecorator = avstantso._reg.FlagsDecorator(({ JS }) => {
+        function isFlagsDecorator(candidate) {
+            return (candidate
+                && JS.is.object(candidate)
+                && JS.is.function(candidate.expand)
+                && JS.is.function(candidate.omit));
+        }
+        /* eslint-disable @typescript-eslint/no-explicit-any */
+        const FlagsDecorator = (map, param) => {
+            const clearMap = Object.entries(map).reduce((r, [key, name]) => {
+                const flag = Number.parseInt(key, 10);
+                if (!Number.isNaN(flag))
+                    r.push([flag, name]);
+                return r;
+            }, []);
+            function expand(entity) {
+                const options = JS.is.object(param)
+                    ? param
+                    : undefined;
+                const initialFlags = JS.is.number(param) ? param : options?.flags;
+                const field = (JS.is.string(param) ? param : options?.field) || 'flags';
+                const read = JS.is.number(initialFlags) && !options?.readable
+                    ? () => initialFlags
+                    : JS.is.function(options?.readable)
+                        ? options.readable
+                        : () => entity[field];
+                const write = !options?.writable
+                    ? undefined
+                    : JS.is.function(options.writable)
+                        ? options.writable
+                        : (flags) => Object.assign(entity, { [field]: flags });
+                for (const [flag, name] of clearMap)
+                    Object.defineProperty(entity, name, Object.assign(
+                    /* eslint-disable no-bitwise */
+                    { get: () => (read() & (1 << flag)) > 0 }, write && {
+                        set: (value) => {
+                            write(value ? read() | (1 << flag) : read() & ~(1 << flag));
+                        }
+                    }
+                    /* eslint-enable no-bitwise */
+                    ));
+                return entity;
+            }
+            function omit(entity) {
+                for (const [, name] of clearMap)
+                    delete entity[name];
+                return entity;
+            }
+            return { expand, omit };
+        };
+        FlagsDecorator.is = isFlagsDecorator;
+        return FlagsDecorator;
+    });
+})(AVStantso$1 || (AVStantso$1 = {}));
+
+var FlagsDecorator = AVStantso.FlagsDecorator;
+
+exports.FlagsDecorator = FlagsDecorator;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/_global/_register.ts","../src/export.ts"],"sourcesContent":["namespace AVStantso {\n  /**\n   * @summary Add/Remove control of entity extension by boolean fields from flags value\n   * @example\n   * export const UserFlagsDecorator = FlagsDecorator([\n   *   'system',    // = 1 << 0\n   *   'test',      // = 1 << 1\n   *   'no_login',  // = 1 << 2\n   *   'no_author', // = 1 << 3\n   *   'demo',      // = 1 << 4\n   * ]);\n   *\n   * const user = {flags: 7} // system | test | no_login\n   *\n   * function print(caption: string) {\n   *   console.log(`${caption}: %O`, {\n   *     system: user.system,\n   *     test: user.test,\n   *     no_login: user.no_login,\n   *     no_author: user.no_author,\n   *     demo: user.demo,\n   *   });\n   * }\n   *\n   * print(`Without extension`);\n   * // Outputs: Without extension\n   * // {\n   * //   system: undefined,\n   * //   test: undefined,\n   * //   no_login: undefined,\n   * //   no_author: undefined,\n   * //   demo: undefined,\n   * // }\n   *\n   * // Add properties\n   * UserFlagsDecorator.expand(user);\n   *\n   * print(`With extension`);\n   * // Outputs: With extension\n   * // {\n   * //   system: true,     // 👈 (user.flags & 1 << 0) > 0\n   * //   test: true,       // 👈 (user.flags & 1 << 1) > 0\n   * //   no_login: true,   // 👈 (user.flags & 1 << 2) > 0\n   * //   no_author: false, // 👈 (user.flags & 1 << 3) > 0\n   * //   demo: false,      // 👈 (user.flags & 1 << 4) > 0\n   * // }\n   *\n   * user.no_login = false; // ≡ user.flags = user.flags & ~4;\n   *\n   * // Remove properties\n   * UserFlagsDecorator.omit(user);\n   *\n   * print(`After omit`);\n   * // Outputs: After omit\n   * // {\n   * //   system: undefined,\n   * //   test: undefined,\n   * //   no_login: undefined,\n   * //   no_author: undefined,\n   * //   demo: undefined,\n   * // }\n   */\n  export namespace FlagsDecorator {\n    export type Map = { [x: number]: string };\n\n    export type Readable = boolean | (() => number);\n\n    export type Writable = boolean | ((flags: number) => void);\n\n    export type Options<TFlagsFieldName extends string = string> = {\n      field?: TFlagsFieldName;\n      flags?: number;\n      readable?: Readable;\n      writable?: Writable;\n    };\n  }\n\n  export type FlagsDecorator<TMap extends FlagsDecorator.Map> = {\n  /**\n   * @summary Add properties by `Object.defineProperty` to `entity`. Mutate `entity`\n   */\n    expand<T extends object>(entity: T): T & Record<keyof TS.Structure.Reverse<TMap>, boolean>;\n\n    /**\n   * @summary Remove propertiyes by `delete`. Mutate `entity`\n   */\n    omit<T extends object>(entity: T): Omit<T, keyof TS.Structure.Reverse<TMap>>;\n  };\n\n  export namespace Code {\n    /**\n     * @summary FlagsDecorator utilities\n     */\n    export namespace FlagsDecorator {\n      export type Overload = {\n        <TMap extends AVStantso.FlagsDecorator.Map, TFlagsFieldName extends string = 'flags'>(\n          map: TMap,\n          options?: AVStantso.FlagsDecorator.Options<TFlagsFieldName>\n        ): FlagsDecorator<TMap>;\n\n        <TMap extends AVStantso.FlagsDecorator.Map, TFlagsFieldName extends string = 'flags'>(\n          map: TMap,\n          field?: TFlagsFieldName\n        ): FlagsDecorator<TMap>;\n\n        <TMap extends AVStantso.FlagsDecorator.Map>(map: TMap, flags: number): FlagsDecorator<TMap>;\n\n        is<\n          TMap extends AVStantso.FlagsDecorator.Map = AVStantso.FlagsDecorator.Map\n        >(candidate: unknown): candidate is FlagsDecorator<TMap>;\n      };\n    }\n  }\n\n  export interface Code {\n    /**\n     * @summary FlagsDecorator utilities\n     */\n    FlagsDecorator: Code.FlagsDecorator.Overload;\n  }\n\n  export const FlagsDecorator: Code.FlagsDecorator.Overload = avstantso._reg.FlagsDecorator(\n    ({ JS }) => {\n      function isFlagsDecorator<\n        TMap extends AVStantso.FlagsDecorator.Map = AVStantso.FlagsDecorator.Map\n      >(candidate: unknown): candidate is FlagsDecorator<TMap> {\n        return (\n          candidate\n          && JS.is.object<FlagsDecorator<TMap>>(candidate)\n          && JS.is.function(candidate.expand)\n          && JS.is.function(candidate.omit)\n        );\n      }\n\n      /* eslint-disable @typescript-eslint/no-explicit-any */\n\n      const FlagsDecorator: Code.FlagsDecorator.Overload = (\n        map: any,\n        param: any\n      ) => {\n        const clearMap = Object.entries(map).reduce((r, [key, name]) => {\n          const flag = Number.parseInt(key, 10);\n          if (!Number.isNaN(flag)) r.push([flag, name as string]);\n\n          return r;\n        }, [] as [number, string][]);\n\n        function expand<T extends object>(entity: T): any {\n          const options: FlagsDecorator.Options = JS.is.object(param)\n            ? param\n            : undefined;\n\n          const initialFlags = JS.is.number(param) ? param : options?.flags;\n          const field = (JS.is.string(param) ? param : options?.field) || 'flags';\n\n          const read: () => number =\n            JS.is.number(initialFlags) && !options?.readable\n              ? () => initialFlags\n              : JS.is.function(options?.readable)\n                ? options.readable\n                : () => (entity as any)[field];\n\n          const write = !options?.writable\n            ? undefined\n            : JS.is.function(options.writable)\n              ? options.writable\n              : (flags: number) => Object.assign(entity, { [field]: flags });\n\n          for (const [flag, name] of clearMap)\n            Object.defineProperty(entity, name as keyof T,\n              Object.assign(\n                /* eslint-disable no-bitwise */\n                { get: () => (read() & (1 << flag)) > 0 },\n                write && {\n                  set: (value: boolean) => {\n                    write(value ? read() | (1 << flag) : read() & ~(1 << flag));\n                  }\n                }\n                /* eslint-enable no-bitwise */\n              )\n            );\n\n          return entity;\n        }\n\n        function omit<T extends object>(entity: T): any {\n          for (const [, name] of clearMap)\n            delete entity[name as keyof T];\n\n          return entity;\n        }\n\n        return { expand, omit };\n      };\n\n      FlagsDecorator.is = isFlagsDecorator;\n      return FlagsDecorator;\n    });\n\n}\n","import FlagsDecorator = AVStantso.FlagsDecorator;\n\nexport {\n  FlagsDecorator\n};\n"],"names":["AVStantso"],"mappings":";;;;;AAAA,IAAUA,WAAS;AAAnB,CAAA,UAAU,SAAS,EAAA;AAyHJ,IAAA,SAAA,CAAA,cAAc,GAAiC,SAAS,CAAC,IAAI,CAAC,cAAc,CACvF,CAAC,EAAE,EAAE,EAAE,KAAI;QACT,SAAS,gBAAgB,CAEvB,SAAkB,EAAA;AAClB,YAAA,QACE;AACG,mBAAA,EAAE,CAAC,EAAE,CAAC,MAAM,CAAuB,SAAS;mBAC5C,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM;mBAC/B,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC;QAErC;;AAIA,QAAA,MAAM,cAAc,GAAiC,CACnD,GAAQ,EACR,KAAU,KACR;YACF,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,KAAI;gBAC7D,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC;AACrC,gBAAA,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;oBAAE,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,IAAc,CAAC,CAAC;AAEvD,gBAAA,OAAO,CAAC;YACV,CAAC,EAAE,EAAwB,CAAC;YAE5B,SAAS,MAAM,CAAmB,MAAS,EAAA;gBACzC,MAAM,OAAO,GAA2B,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK;AACxD,sBAAE;sBACA,SAAS;gBAEb,MAAM,YAAY,GAAG,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,OAAO,EAAE,KAAK;gBACjE,MAAM,KAAK,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,OAAO,EAAE,KAAK,KAAK,OAAO;AAEvE,gBAAA,MAAM,IAAI,GACR,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE;AACtC,sBAAE,MAAM;sBACN,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ;0BAC9B,OAAO,CAAC;0BACR,MAAO,MAAc,CAAC,KAAK,CAAC;AAEpC,gBAAA,MAAM,KAAK,GAAG,CAAC,OAAO,EAAE;AACtB,sBAAE;sBACA,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ;0BAC7B,OAAO,CAAC;0BACR,CAAC,KAAa,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,GAAG,KAAK,EAAE,CAAC;AAElE,gBAAA,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,QAAQ;oBACjC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,IAAe,EAC3C,MAAM,CAAC,MAAM;;oBAEX,EAAE,GAAG,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,EACzC,KAAK,IAAI;AACP,wBAAA,GAAG,EAAE,CAAC,KAAc,KAAI;4BACtB,KAAK,CAAC,KAAK,GAAG,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC;wBAC7D;AACD;;AAEF,qBAAA,CACF;AAEH,gBAAA,OAAO,MAAM;YACf;YAEA,SAAS,IAAI,CAAmB,MAAS,EAAA;AACvC,gBAAA,KAAK,MAAM,GAAG,IAAI,CAAC,IAAI,QAAQ;AAC7B,oBAAA,OAAO,MAAM,CAAC,IAAe,CAAC;AAEhC,gBAAA,OAAO,MAAM;YACf;AAEA,YAAA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE;AACzB,QAAA,CAAC;AAED,QAAA,cAAc,CAAC,EAAE,GAAG,gBAAgB;AACpC,QAAA,OAAO,cAAc;AACvB,IAAA,CAAC,CAAC;AAEN,CAAC,EAvMSA,WAAS,KAATA,WAAS,GAAA,EAAA,CAAA,CAAA;;ACAnB,IAAO,cAAc,GAAG,SAAS,CAAC;;;;"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@avstantso/utils-flags-decorator",
   "license": "MIT",
   "author": "avstantso",
-  "version": "1.1.0",
+  "version": "1.2.2",
   "description": "AVStantso framework utils: FlagsDecorator",
   "keywords": [
     "FlagsDecorator"
@@ -23,12 +23,12 @@
     "test": "NODE_ENV=test jest --coverage"
   },
   "dependencies": {
-    "@avstantso/concepts": "1.1.0",
-    "@avstantso/core": "1.1.0",
-    "@avstantso/errors": "1.1.0",
-    "@avstantso/js": "1.1.0",
-    "@avstantso/std-ext": "1.1.0",
-    "@avstantso/ts": "1.1.0"
+    "@avstantso/concepts": "1.2.2",
+    "@avstantso/core": "1.2.1",
+    "@avstantso/errors": "1.2.1",
+    "@avstantso/js": "1.2.2",
+    "@avstantso/std-ext": "1.2.1",
+    "@avstantso/ts": "1.3.0"
   },
   "devDependencies": {
     "@avstantso/dev-basic": "1.0.0"