@alwatr/nitrobase-user-management 7.5.0

package/README.md

@@ -0,0 +1,101 @@
+# Nitrobase User Management
+
+User management module for Nitrobase, providing user creation, authentication, and data management capabilities.
+
+## Installation
+
+```bash
+npm install @alwatr/nitrobase
+```
+
+## Usage
+
+```typescript
+import {AlwatrNitrobase, NitrobaseUserManagement, type NewUser} from '@alwatr/nitrobase';
+
+// Define your user data structure
+interface MyUserData {
+  name: string;
+  email: string;
+  // ... other properties
+}
+
+// Initialize Nitrobase
+const nitrobase = new AlwatrNitrobase({
+  // ... your nitrobase configuration
+});
+
+// Initialize User Management
+await NitrobaseUserManagement.initialize(nitrobase);
+
+const userManagement = new NitrobaseUserManagement<MyUserData>(nitrobase);
+
+// Create a new user
+const newUser: NewUser<MyUserData> = {
+  userId: 'user123',
+  userToken: 'some_secure_token',
+  data: {
+    name: 'John Doe',
+    email: 'john.doe@example.com',
+  },
+};
+
+await userManagement.newUser(newUser);
+
+// Check if a user exists
+const userExists = await userManagement.hasUser('user123');
+console.log('User exists:', userExists); // Output: User exists: true
+
+// Get user data
+const userData = await userManagement.getUserData('user123');
+console.log('User data:', userData); // Output: User data: { name: 'John Doe', email: 'john.doe@example.com' }
+
+// Verify user token
+const isValidToken = await userManagement.verifyUserToken('user123', 'some_secure_token');
+console.log('Is valid token:', isValidToken); // Output: Is valid token: true
+
+// Save user data (after modifications)
+userData.email = 'john.updated@example.com'
+userManagement.save('user123') // Background save
+userManagement.saveImmediate('user123') // Immediate save (blocking)
+
+
+// Get all user IDs
+const userIds = await userManagement.userIds();
+for await (const userId of userIds) {
+  console.log('User ID:', userId);
+}
+
+// Get user directory
+const userDir = await userManagement.getUserDirectory('user123');
+console.log('User directory:', userDir);
+```
+
+## API
+
+### `NitrobaseUserManagement`
+
+- **`static initialize(nitrobase: AlwatrNitrobase): Promise<void>`:** Initializes the user management module. Must be called before creating a `NitrobaseUserManagement` instance.
+- **`newUser(user: NewUser<TUser>): Promise<void>`:** Creates a new user with the provided data and token.  Sets up necessary storage and metadata.
+- **`hasUser(userId: string): Promise<boolean>`:** Checks if a user with the given ID exists.
+- **`getUserData(userId: string): Promise<TUser>`:** Retrieves the data associated with the given user ID.
+- **`getUserMeta(userId: string): Promise<Readonly<StoreFileMeta>>`:** Retrieves metadata about the user's stored information.
+- **`verifyUserToken(userId: string, token: string): Promise<boolean>`:** Verifies the provided token against the stored token for the user.
+- **`save(userId: string): void`:** Saves any changes to the user's data. This operation is non-blocking.
+- **`saveImmediate(userId: string): void`:** Immediately saves changes to the user's data.  This operation is blocking.
+- **`userIds(): Promise<Generator<string, void, void>>`:** Returns an asynchronous generator that yields all user IDs.
+- **`getUserDirectory(userId: string): Promise<string>`:** Retrieves the file system directory associated with the user.
+
+## Types
+
+- **`NewUser<TUser extends JsonObject>`:**  Represents the data required to create a new user. Includes user ID, token, and user-specific data.
+
+## Contributing
+
+Contributions are welcome! Please read our [contribution guidelines](https://github.com/Alwatr/.github/blob/next/CONTRIBUTING.md) before submitting a pull request.
+
+## License
+
+This project is licensed under the [AGPL-3.0 License](LICENSE).
+
+```

package/dist/logger.d.ts

@@ -0,0 +1,2 @@
+export declare const logger: import("@alwatr/logger").AlwatrLogger;
+//# sourceMappingURL=logger.d.ts.map

package/dist/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,MAAM,uCAAiD,CAAC"}

package/dist/main.cjs

@@ -0,0 +1,182 @@
+/* @alwatr/nitrobase-user-management v7.5.0 */
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/main.ts
+var main_exports = {};
+__export(main_exports, {
+  NitrobaseUserManagement: () => NitrobaseUserManagement
+});
+module.exports = __toCommonJS(main_exports);
+
+// src/user-management.ts
+var import_node_path = require("node:path");
+var import_nanolib2 = require("@alwatr/nanolib");
+var import_node_fs = require("@alwatr/nanolib/node-fs");
+var import_nitrobase_types = require("@alwatr/nitrobase-types");
+
+// src/logger.ts
+var import_nanolib = require("@alwatr/nanolib");
+__dev_mode__: import_nanolib.packageTracer.add("@alwatr/nitrobase-user-management", "7.5.0");
+var logger = /* @__PURE__ */ (0, import_nanolib.createLogger)("@alwatr/nitrobase-user-management");
+
+// src/user-management.ts
+var _NitrobaseUserManagement = class _NitrobaseUserManagement {
+  /**
+   * Create a new instance of NitrobaseUserManagement.
+   * @param nitrobase_ The Nitrobase instance.
+   */
+  constructor(nitrobase_) {
+    this.nitrobase_ = nitrobase_;
+    this.logger_ = (0, import_nanolib2.createLogger)("user-management");
+    this.logger_.logMethod?.("constructor");
+    this.userListCollection_ = this.nitrobase_.openCollection(_NitrobaseUserManagement.nitrobaseIds.userList);
+  }
+  /**
+   * Initialize the user management module.
+   * @param nitrobase The Nitrobase instance.
+   */
+  static async initialize(nitrobase) {
+    logger.logMethod?.("NitrobaseUserManagement.initialize");
+    nitrobase.newCollection(this.nitrobaseIds.userList);
+  }
+  // Implementation of NitrobaseUserManagementInterface methods with JSDoc comments
+  async newUser(user) {
+    this.logger_.logMethodArgs?.("newUser", user);
+    (await this.userListCollection_).addItem(user.userId, {});
+    this.newUserInfoDocument_(user.userId, user.data);
+    await this.makeTokenFile_(user.userId, user.userToken, user.isManager);
+  }
+  async hasUser(userId) {
+    const userExists = (await this.userListCollection_).hasItem(userId);
+    this.logger_.logMethodFull?.("hasUser", { userId }, userExists);
+    return userExists;
+  }
+  async getUserData(userId) {
+    this.logger_.logMethodArgs?.("getUserData", userId);
+    const userInfoDocument = await this.openUserInfoDocument_(userId);
+    return userInfoDocument.getData();
+  }
+  async getUserMeta(userId) {
+    this.logger_.logMethodArgs?.("getUserMeta", userId);
+    const document = await this.openUserInfoDocument_(userId);
+    return document.getStoreMeta();
+  }
+  save(userId) {
+    this.logger_.logMethodArgs?.("save", userId);
+    this.openUserInfoDocument_(userId).then((document) => {
+      document.save();
+    });
+  }
+  saveImmediate(userId) {
+    this.logger_.logMethodArgs?.("saveImmediate", userId);
+    this.openUserInfoDocument_(userId).then((document) => {
+      document.saveImmediate();
+    });
+  }
+  async userIds() {
+    return (await this.userListCollection_).ids();
+  }
+  async verifyUserToken(userId, token) {
+    const tokenFileExist = (0, import_node_fs.existsSync)(await this.getUserTokenFilePath_(userId, token));
+    this.logger_.logMethodFull?.("verifyUserToken", { userId, token: token.slice(0, 12) + "..." }, tokenFileExist);
+    return tokenFileExist;
+  }
+  async getUserDirectory(userId) {
+    const userInfoDocument = await this.openUserInfoDocument_(userId);
+    const userDirectoryPath = (0, import_node_path.dirname)((0, import_node_path.resolve)(this.nitrobase_.config.rootPath, userInfoDocument.path));
+    this.logger_.logMethodFull?.("getUserDirectory", { userId }, userDirectoryPath);
+    return userDirectoryPath;
+  }
+  /**
+   * Create a new user info document.
+   * @param userId The user ID.
+   * @param userInfo The user info data.
+   */
+  newUserInfoDocument_(userId, userInfo) {
+    this.logger_.logMethodArgs?.("newUserInfoDocument", { userId, userInfo });
+    const storeId = {
+      ..._NitrobaseUserManagement.nitrobaseIds.userInfo,
+      ownerId: userId
+    };
+    if (this.nitrobase_.hasStore(storeId)) {
+      this.logger_.accident?.("newUserInfoDocument_", "store_already_exists", storeId);
+      return;
+    }
+    this.nitrobase_.newDocument(storeId, userInfo);
+  }
+  /**
+   * Open the user info document.
+   * @param userId The user ID.
+   * @returns A promise resolving to the user info document.
+   */
+  openUserInfoDocument_(userId) {
+    this.logger_.logMethodArgs?.("openUserInfoDocument_", userId);
+    return this.nitrobase_.openDocument({
+      ..._NitrobaseUserManagement.nitrobaseIds.userInfo,
+      ownerId: userId
+    });
+  }
+  /**
+   * Create a token file for the user.
+   * @param userId The user ID.
+   * @param token The user token.
+   * @param isManager Whether the user is a manager.
+   */
+  async makeTokenFile_(userId, token, isManager) {
+    this.logger_.logMethodArgs?.("makeTokenFile", { userId, token: token.slice(0, 12) + "...", isManager });
+    const userDirectory = await this.getUserDirectory(userId);
+    await (0, import_node_fs.makeEmptyFile)((0, import_node_path.resolve)(userDirectory, `.token/${token}.asn`));
+    if (isManager === true) {
+      await (0, import_node_fs.makeEmptyFile)((0, import_node_path.resolve)(userDirectory, ".auth/manager.asn"));
+    }
+  }
+  /**
+   * Get the path to the user token file.
+   * @param userId The user ID.
+   * @param token The user token.
+   * @returns The path to the user token file.
+   */
+  async getUserTokenFilePath_(userId, token) {
+    const userTokenFilePath = (0, import_node_path.resolve)(await this.getUserDirectory(userId), `.token/${token}.asn`);
+    this.logger_.logMethodFull?.("getTokenFilePath", { userId, token: token.slice(0, 12) + "..." }, userTokenFilePath);
+    return userTokenFilePath;
+  }
+};
+/**
+ * Default Nitrobase store IDs used by this class.
+ */
+_NitrobaseUserManagement.nitrobaseIds = {
+  userList: {
+    name: "user-list",
+    region: import_nitrobase_types.Region.Managers,
+    schemaVer: 1
+  },
+  userInfo: {
+    name: "user-info",
+    region: import_nitrobase_types.Region.PerUser
+  }
+};
+var NitrobaseUserManagement = _NitrobaseUserManagement;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  NitrobaseUserManagement
+});
+/*! For license information please see main.cjs.LEGAL.txt */
+//# sourceMappingURL=main.cjs.map

package/dist/main.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/main.ts", "../src/user-management.ts", "../src/logger.ts"],
+  "sourcesContent": ["export * from './user-management.js';\n", "import {dirname, resolve} from 'node:path';\n\nimport {createLogger} from '@alwatr/nanolib';\nimport {existsSync, makeEmptyFile} from '@alwatr/nanolib/node-fs';\nimport {Region, type AlwatrAuth, type StoreFileId, type StoreFileMeta} from '@alwatr/nitrobase-types';\n\nimport {logger} from './logger.js';\n\nimport type {AlwatrNitrobase} from '@alwatr/nitrobase-engine';\nimport type {DocumentReference} from '@alwatr/nitrobase-reference';\n\n/**\n * New user data type.\n */\nexport type NewUser<TUser extends JsonObject> = AlwatrAuth & {\n  data: TUser;\n  isManager?: true;\n};\n\n/**\n * Nitrobase User Management Interface.\n */\ninterface NitrobaseUserManagementInterface<TUser extends JsonObject> {\n\n  /**\n   * Create a new user.\n   * @param user The new user data.\n   */\n  newUser(user: NewUser<TUser>): Promise<void>;\n\n  /**\n   * Check if a user exists.\n   * @param userId The user ID.\n   * @returns True if the user exists, false otherwise.\n   */\n  hasUser(userId: string): Promise<boolean>;\n\n  /**\n   * Get user data.\n   * @param userId The user ID.\n   * @returns The user data.\n   */\n  getUserData(userId: string): Promise<TUser>;\n\n  /**\n   * Get user meta data.\n   * @param userId The user ID.\n   * @returns The user meta data.\n   */\n  getUserMeta(userId: string): Promise<Readonly<StoreFileMeta>>;\n\n  /**\n   * Verify user token.\n   * @param userId The user ID.\n   * @param token The user token.\n   * @returns True if the token is valid, false otherwise.\n   */\n  verifyUserToken(userId: string, token: string): Promise<boolean>;\n\n\n  /**\n   * Save user data to storage.\n   * @param userId The user ID.\n   */\n  save(userId: string): void;\n\n  /**\n   * Immediately save user data to storage.\n   * @param userId The user ID.\n   */\n  saveImmediate(userId: string): void;\n\n  /**\n   * Get all user IDs.\n   * @returns An async generator of user IDs.\n   */\n  userIds(): Promise<Generator<string, void, void>>;\n\n  /**\n   * Get the user directory path.\n   * @param userId The user ID.\n   * @returns The user directory path.\n   */\n  getUserDirectory(userId: string): Promise<string>;\n}\n\n/**\n * Nitrobase User Management Class.\n * Manages user data and authentication.\n */\nexport class NitrobaseUserManagement<TUser extends JsonObject> implements NitrobaseUserManagementInterface<TUser> {\n\n  /**\n   * Default Nitrobase store IDs used by this class.\n   */\n  static readonly nitrobaseIds = {\n    userList: {\n      name: 'user-list',\n      region: Region.Managers,\n      schemaVer: 1,\n    } as Readonly<StoreFileId>,\n\n    userInfo: {\n      name: 'user-info',\n      region: Region.PerUser,\n    } as Readonly<StoreFileId>,\n  } as const;\n\n  /**\n   * Initialize the user management module.\n   * @param nitrobase The Nitrobase instance.\n   */\n  static async initialize(nitrobase: AlwatrNitrobase): Promise<void> {\n    logger.logMethod?.('NitrobaseUserManagement.initialize');\n    nitrobase.newCollection(this.nitrobaseIds.userList);\n  }\n\n  protected logger_ = createLogger('user-management');\n\n  protected userListCollection_;\n\n  /**\n   * Create a new instance of NitrobaseUserManagement.\n   * @param nitrobase_ The Nitrobase instance.\n   */\n  constructor(\n    protected readonly nitrobase_: AlwatrNitrobase,\n  ) {\n    this.logger_.logMethod?.('constructor');\n    this.userListCollection_ = this.nitrobase_.openCollection(NitrobaseUserManagement.nitrobaseIds.userList);\n  }\n\n\n\n  // Implementation of NitrobaseUserManagementInterface methods with JSDoc comments\n\n  async newUser(user: NewUser<TUser>): Promise<void> {\n    this.logger_.logMethodArgs?.('newUser', user);\n\n    (await this.userListCollection_).addItem(user.userId, {});\n\n    this.newUserInfoDocument_(user.userId, user.data);\n\n    await this.makeTokenFile_(user.userId, user.userToken, user.isManager);\n  }\n\n  async hasUser(userId: string): Promise<boolean> {\n    const userExists = (await this.userListCollection_).hasItem(userId);\n    this.logger_.logMethodFull?.('hasUser', {userId}, userExists);\n    return userExists;\n  }\n\n  async getUserData(userId: string): Promise<TUser> {\n    this.logger_.logMethodArgs?.('getUserData', userId);\n    const userInfoDocument = await this.openUserInfoDocument_(userId);\n    return userInfoDocument.getData();\n  }\n\n  async getUserMeta(userId: string): Promise<Readonly<StoreFileMeta>> {\n    this.logger_.logMethodArgs?.('getUserMeta', userId);\n    const document = await this.openUserInfoDocument_(userId);\n    return document.getStoreMeta();\n  }\n\n  save(userId: string): void {\n    this.logger_.logMethodArgs?.('save', userId);\n    this.openUserInfoDocument_(userId).then((document) => {\n      document.save();\n    });\n  }\n\n  saveImmediate(userId: string): void {\n    this.logger_.logMethodArgs?.('saveImmediate', userId);\n    this.openUserInfoDocument_(userId).then((document) => {\n      document.saveImmediate();\n    });\n  }\n\n  async userIds(): Promise<Generator<string, void, void>> {\n    return (await this.userListCollection_).ids();\n  }\n\n  async verifyUserToken(userId: string, token: string): Promise<boolean> {\n    const tokenFileExist = existsSync(await this.getUserTokenFilePath_(userId, token));\n    this.logger_.logMethodFull?.('verifyUserToken', {userId, token: token.slice(0, 12) + '...'}, tokenFileExist);\n    return tokenFileExist;\n  }\n\n  async getUserDirectory(userId: string): Promise<string> {\n    const userInfoDocument = await this.openUserInfoDocument_(userId);\n    const userDirectoryPath = dirname(resolve(this.nitrobase_.config.rootPath, userInfoDocument.path));\n    this.logger_.logMethodFull?.('getUserDirectory', {userId}, userDirectoryPath);\n    return userDirectoryPath;\n  }\n\n  /**\n   * Create a new user info document.\n   * @param userId The user ID.\n   * @param userInfo The user info data.\n   */\n  protected newUserInfoDocument_(userId: string, userInfo: TUser): void {\n    this.logger_.logMethodArgs?.('newUserInfoDocument', {userId, userInfo});\n    const storeId: StoreFileId = {\n      ...NitrobaseUserManagement.nitrobaseIds.userInfo,\n      ownerId: userId,\n    };\n    if (this.nitrobase_.hasStore(storeId)) {\n      this.logger_.accident?.('newUserInfoDocument_', 'store_already_exists', storeId);\n      return;\n    }\n    this.nitrobase_.newDocument<TUser>(storeId, userInfo);\n  }\n\n  /**\n   * Open the user info document.\n   * @param userId The user ID.\n   * @returns A promise resolving to the user info document.\n   */\n  protected openUserInfoDocument_(userId: string): Promise<DocumentReference<TUser>> {\n    this.logger_.logMethodArgs?.('openUserInfoDocument_', userId);\n    return this.nitrobase_.openDocument<TUser>({\n      ...NitrobaseUserManagement.nitrobaseIds.userInfo,\n      ownerId: userId,\n    });\n  }\n\n  /**\n   * Create a token file for the user.\n   * @param userId The user ID.\n   * @param token The user token.\n   * @param isManager Whether the user is a manager.\n   */\n  protected async makeTokenFile_(userId: string, token: string, isManager?: true): Promise<void> {\n    this.logger_.logMethodArgs?.('makeTokenFile', {userId, token: token.slice(0, 12) + '...', isManager});\n    const userDirectory = await this.getUserDirectory(userId);\n\n    await makeEmptyFile(resolve(userDirectory, `.token/${token}.asn`));\n\n    if (isManager === true) {\n      await makeEmptyFile(resolve(userDirectory, '.auth/manager.asn'));\n    }\n  }\n\n  /**\n   * Get the path to the user token file.\n   * @param userId The user ID.\n   * @param token The user token.\n   * @returns The path to the user token file.\n   */\n  protected async getUserTokenFilePath_(userId: string, token: string): Promise<string> {\n    const userTokenFilePath = resolve(await this.getUserDirectory(userId), `.token/${token}.asn`);\n    this.logger_.logMethodFull?.('getTokenFilePath', {userId, token: token.slice(0, 12) + '...'}, userTokenFilePath);\n    return userTokenFilePath;\n  }\n}\n", "import {createLogger, packageTracer} from '@alwatr/nanolib';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\nexport const logger = /* #__PURE__ */ createLogger(__package_name__);\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,uBAA+B;AAE/B,IAAAA,kBAA2B;AAC3B,qBAAwC;AACxC,6BAA4E;;;ACJ5E,qBAA0C;AAE1C,aAAc,8BAAc,IAAI,qCAAkB,OAAmB;AAE9D,IAAM,SAAyB,iDAAa,mCAAgB;;;ADsF5D,IAAM,2BAAN,MAAM,yBAAqG;AAAA;AAAA;AAAA;AAAA;AAAA,EAmChH,YACqB,YACnB;AADmB;AATrB,SAAU,cAAU,8BAAa,iBAAiB;AAWhD,SAAK,QAAQ,YAAY,aAAa;AACtC,SAAK,sBAAsB,KAAK,WAAW,eAAe,yBAAwB,aAAa,QAAQ;AAAA,EACzG;AAAA;AAAA;AAAA;AAAA;AAAA,EAlBA,aAAa,WAAW,WAA2C;AACjE,WAAO,YAAY,oCAAoC;AACvD,cAAU,cAAc,KAAK,aAAa,QAAQ;AAAA,EACpD;AAAA;AAAA,EAqBA,MAAM,QAAQ,MAAqC;AACjD,SAAK,QAAQ,gBAAgB,WAAW,IAAI;AAE5C,KAAC,MAAM,KAAK,qBAAqB,QAAQ,KAAK,QAAQ,CAAC,CAAC;AAExD,SAAK,qBAAqB,KAAK,QAAQ,KAAK,IAAI;AAEhD,UAAM,KAAK,eAAe,KAAK,QAAQ,KAAK,WAAW,KAAK,SAAS;AAAA,EACvE;AAAA,EAEA,MAAM,QAAQ,QAAkC;AAC9C,UAAM,cAAc,MAAM,KAAK,qBAAqB,QAAQ,MAAM;AAClE,SAAK,QAAQ,gBAAgB,WAAW,EAAC,OAAM,GAAG,UAAU;AAC5D,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,YAAY,QAAgC;AAChD,SAAK,QAAQ,gBAAgB,eAAe,MAAM;AAClD,UAAM,mBAAmB,MAAM,KAAK,sBAAsB,MAAM;AAChE,WAAO,iBAAiB,QAAQ;AAAA,EAClC;AAAA,EAEA,MAAM,YAAY,QAAkD;AAClE,SAAK,QAAQ,gBAAgB,eAAe,MAAM;AAClD,UAAM,WAAW,MAAM,KAAK,sBAAsB,MAAM;AACxD,WAAO,SAAS,aAAa;AAAA,EAC/B;AAAA,EAEA,KAAK,QAAsB;AACzB,SAAK,QAAQ,gBAAgB,QAAQ,MAAM;AAC3C,SAAK,sBAAsB,MAAM,EAAE,KAAK,CAAC,aAAa;AACpD,eAAS,KAAK;AAAA,IAChB,CAAC;AAAA,EACH;AAAA,EAEA,cAAc,QAAsB;AAClC,SAAK,QAAQ,gBAAgB,iBAAiB,MAAM;AACpD,SAAK,sBAAsB,MAAM,EAAE,KAAK,CAAC,aAAa;AACpD,eAAS,cAAc;AAAA,IACzB,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,UAAkD;AACtD,YAAQ,MAAM,KAAK,qBAAqB,IAAI;AAAA,EAC9C;AAAA,EAEA,MAAM,gBAAgB,QAAgB,OAAiC;AACrE,UAAM,qBAAiB,2BAAW,MAAM,KAAK,sBAAsB,QAAQ,KAAK,CAAC;AACjF,SAAK,QAAQ,gBAAgB,mBAAmB,EAAC,QAAQ,OAAO,MAAM,MAAM,GAAG,EAAE,IAAI,MAAK,GAAG,cAAc;AAC3G,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,iBAAiB,QAAiC;AACtD,UAAM,mBAAmB,MAAM,KAAK,sBAAsB,MAAM;AAChE,UAAM,wBAAoB,8BAAQ,0BAAQ,KAAK,WAAW,OAAO,UAAU,iBAAiB,IAAI,CAAC;AACjG,SAAK,QAAQ,gBAAgB,oBAAoB,EAAC,OAAM,GAAG,iBAAiB;AAC5E,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,qBAAqB,QAAgB,UAAuB;AACpE,SAAK,QAAQ,gBAAgB,uBAAuB,EAAC,QAAQ,SAAQ,CAAC;AACtE,UAAM,UAAuB;AAAA,MAC3B,GAAG,yBAAwB,aAAa;AAAA,MACxC,SAAS;AAAA,IACX;AACA,QAAI,KAAK,WAAW,SAAS,OAAO,GAAG;AACrC,WAAK,QAAQ,WAAW,wBAAwB,wBAAwB,OAAO;AAC/E;AAAA,IACF;AACA,SAAK,WAAW,YAAmB,SAAS,QAAQ;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,sBAAsB,QAAmD;AACjF,SAAK,QAAQ,gBAAgB,yBAAyB,MAAM;AAC5D,WAAO,KAAK,WAAW,aAAoB;AAAA,MACzC,GAAG,yBAAwB,aAAa;AAAA,MACxC,SAAS;AAAA,IACX,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAgB,eAAe,QAAgB,OAAe,WAAiC;AAC7F,SAAK,QAAQ,gBAAgB,iBAAiB,EAAC,QAAQ,OAAO,MAAM,MAAM,GAAG,EAAE,IAAI,OAAO,UAAS,CAAC;AACpG,UAAM,gBAAgB,MAAM,KAAK,iBAAiB,MAAM;AAExD,cAAM,kCAAc,0BAAQ,eAAe,UAAU,KAAK,MAAM,CAAC;AAEjE,QAAI,cAAc,MAAM;AACtB,gBAAM,kCAAc,0BAAQ,eAAe,mBAAmB,CAAC;AAAA,IACjE;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAgB,sBAAsB,QAAgB,OAAgC;AACpF,UAAM,wBAAoB,0BAAQ,MAAM,KAAK,iBAAiB,MAAM,GAAG,UAAU,KAAK,MAAM;AAC5F,SAAK,QAAQ,gBAAgB,oBAAoB,EAAC,QAAQ,OAAO,MAAM,MAAM,GAAG,EAAE,IAAI,MAAK,GAAG,iBAAiB;AAC/G,WAAO;AAAA,EACT;AACF;AAAA;AAAA;AAAA;AApKa,yBAKK,eAAe;AAAA,EAC7B,UAAU;AAAA,IACR,MAAM;AAAA,IACN,QAAQ,8BAAO;AAAA,IACf,WAAW;AAAA,EACb;AAAA,EAEA,UAAU;AAAA,IACR,MAAM;AAAA,IACN,QAAQ,8BAAO;AAAA,EACjB;AACF;AAhBK,IAAM,0BAAN;",
+  "names": ["import_nanolib"]
+}

package/dist/main.d.ts

@@ -0,0 +1,2 @@
+export * from './user-management.js';
+//# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC"}

package/dist/main.mjs

@@ -0,0 +1,156 @@
+/* @alwatr/nitrobase-user-management v7.5.0 */
+
+// src/user-management.ts
+import { dirname, resolve } from "node:path";
+import { createLogger as createLogger2 } from "@alwatr/nanolib";
+import { existsSync, makeEmptyFile } from "@alwatr/nanolib/node-fs";
+import { Region } from "@alwatr/nitrobase-types";
+
+// src/logger.ts
+import { createLogger, packageTracer } from "@alwatr/nanolib";
+__dev_mode__: packageTracer.add("@alwatr/nitrobase-user-management", "7.5.0");
+var logger = /* @__PURE__ */ createLogger("@alwatr/nitrobase-user-management");
+
+// src/user-management.ts
+var _NitrobaseUserManagement = class _NitrobaseUserManagement {
+  /**
+   * Create a new instance of NitrobaseUserManagement.
+   * @param nitrobase_ The Nitrobase instance.
+   */
+  constructor(nitrobase_) {
+    this.nitrobase_ = nitrobase_;
+    this.logger_ = createLogger2("user-management");
+    this.logger_.logMethod?.("constructor");
+    this.userListCollection_ = this.nitrobase_.openCollection(_NitrobaseUserManagement.nitrobaseIds.userList);
+  }
+  /**
+   * Initialize the user management module.
+   * @param nitrobase The Nitrobase instance.
+   */
+  static async initialize(nitrobase) {
+    logger.logMethod?.("NitrobaseUserManagement.initialize");
+    nitrobase.newCollection(this.nitrobaseIds.userList);
+  }
+  // Implementation of NitrobaseUserManagementInterface methods with JSDoc comments
+  async newUser(user) {
+    this.logger_.logMethodArgs?.("newUser", user);
+    (await this.userListCollection_).addItem(user.userId, {});
+    this.newUserInfoDocument_(user.userId, user.data);
+    await this.makeTokenFile_(user.userId, user.userToken, user.isManager);
+  }
+  async hasUser(userId) {
+    const userExists = (await this.userListCollection_).hasItem(userId);
+    this.logger_.logMethodFull?.("hasUser", { userId }, userExists);
+    return userExists;
+  }
+  async getUserData(userId) {
+    this.logger_.logMethodArgs?.("getUserData", userId);
+    const userInfoDocument = await this.openUserInfoDocument_(userId);
+    return userInfoDocument.getData();
+  }
+  async getUserMeta(userId) {
+    this.logger_.logMethodArgs?.("getUserMeta", userId);
+    const document = await this.openUserInfoDocument_(userId);
+    return document.getStoreMeta();
+  }
+  save(userId) {
+    this.logger_.logMethodArgs?.("save", userId);
+    this.openUserInfoDocument_(userId).then((document) => {
+      document.save();
+    });
+  }
+  saveImmediate(userId) {
+    this.logger_.logMethodArgs?.("saveImmediate", userId);
+    this.openUserInfoDocument_(userId).then((document) => {
+      document.saveImmediate();
+    });
+  }
+  async userIds() {
+    return (await this.userListCollection_).ids();
+  }
+  async verifyUserToken(userId, token) {
+    const tokenFileExist = existsSync(await this.getUserTokenFilePath_(userId, token));
+    this.logger_.logMethodFull?.("verifyUserToken", { userId, token: token.slice(0, 12) + "..." }, tokenFileExist);
+    return tokenFileExist;
+  }
+  async getUserDirectory(userId) {
+    const userInfoDocument = await this.openUserInfoDocument_(userId);
+    const userDirectoryPath = dirname(resolve(this.nitrobase_.config.rootPath, userInfoDocument.path));
+    this.logger_.logMethodFull?.("getUserDirectory", { userId }, userDirectoryPath);
+    return userDirectoryPath;
+  }
+  /**
+   * Create a new user info document.
+   * @param userId The user ID.
+   * @param userInfo The user info data.
+   */
+  newUserInfoDocument_(userId, userInfo) {
+    this.logger_.logMethodArgs?.("newUserInfoDocument", { userId, userInfo });
+    const storeId = {
+      ..._NitrobaseUserManagement.nitrobaseIds.userInfo,
+      ownerId: userId
+    };
+    if (this.nitrobase_.hasStore(storeId)) {
+      this.logger_.accident?.("newUserInfoDocument_", "store_already_exists", storeId);
+      return;
+    }
+    this.nitrobase_.newDocument(storeId, userInfo);
+  }
+  /**
+   * Open the user info document.
+   * @param userId The user ID.
+   * @returns A promise resolving to the user info document.
+   */
+  openUserInfoDocument_(userId) {
+    this.logger_.logMethodArgs?.("openUserInfoDocument_", userId);
+    return this.nitrobase_.openDocument({
+      ..._NitrobaseUserManagement.nitrobaseIds.userInfo,
+      ownerId: userId
+    });
+  }
+  /**
+   * Create a token file for the user.
+   * @param userId The user ID.
+   * @param token The user token.
+   * @param isManager Whether the user is a manager.
+   */
+  async makeTokenFile_(userId, token, isManager) {
+    this.logger_.logMethodArgs?.("makeTokenFile", { userId, token: token.slice(0, 12) + "...", isManager });
+    const userDirectory = await this.getUserDirectory(userId);
+    await makeEmptyFile(resolve(userDirectory, `.token/${token}.asn`));
+    if (isManager === true) {
+      await makeEmptyFile(resolve(userDirectory, ".auth/manager.asn"));
+    }
+  }
+  /**
+   * Get the path to the user token file.
+   * @param userId The user ID.
+   * @param token The user token.
+   * @returns The path to the user token file.
+   */
+  async getUserTokenFilePath_(userId, token) {
+    const userTokenFilePath = resolve(await this.getUserDirectory(userId), `.token/${token}.asn`);
+    this.logger_.logMethodFull?.("getTokenFilePath", { userId, token: token.slice(0, 12) + "..." }, userTokenFilePath);
+    return userTokenFilePath;
+  }
+};
+/**
+ * Default Nitrobase store IDs used by this class.
+ */
+_NitrobaseUserManagement.nitrobaseIds = {
+  userList: {
+    name: "user-list",
+    region: Region.Managers,
+    schemaVer: 1
+  },
+  userInfo: {
+    name: "user-info",
+    region: Region.PerUser
+  }
+};
+var NitrobaseUserManagement = _NitrobaseUserManagement;
+export {
+  NitrobaseUserManagement
+};
+/*! For license information please see main.mjs.LEGAL.txt */
+//# sourceMappingURL=main.mjs.map

package/dist/main.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/user-management.ts", "../src/logger.ts"],
+  "sourcesContent": ["import {dirname, resolve} from 'node:path';\n\nimport {createLogger} from '@alwatr/nanolib';\nimport {existsSync, makeEmptyFile} from '@alwatr/nanolib/node-fs';\nimport {Region, type AlwatrAuth, type StoreFileId, type StoreFileMeta} from '@alwatr/nitrobase-types';\n\nimport {logger} from './logger.js';\n\nimport type {AlwatrNitrobase} from '@alwatr/nitrobase-engine';\nimport type {DocumentReference} from '@alwatr/nitrobase-reference';\n\n/**\n * New user data type.\n */\nexport type NewUser<TUser extends JsonObject> = AlwatrAuth & {\n  data: TUser;\n  isManager?: true;\n};\n\n/**\n * Nitrobase User Management Interface.\n */\ninterface NitrobaseUserManagementInterface<TUser extends JsonObject> {\n\n  /**\n   * Create a new user.\n   * @param user The new user data.\n   */\n  newUser(user: NewUser<TUser>): Promise<void>;\n\n  /**\n   * Check if a user exists.\n   * @param userId The user ID.\n   * @returns True if the user exists, false otherwise.\n   */\n  hasUser(userId: string): Promise<boolean>;\n\n  /**\n   * Get user data.\n   * @param userId The user ID.\n   * @returns The user data.\n   */\n  getUserData(userId: string): Promise<TUser>;\n\n  /**\n   * Get user meta data.\n   * @param userId The user ID.\n   * @returns The user meta data.\n   */\n  getUserMeta(userId: string): Promise<Readonly<StoreFileMeta>>;\n\n  /**\n   * Verify user token.\n   * @param userId The user ID.\n   * @param token The user token.\n   * @returns True if the token is valid, false otherwise.\n   */\n  verifyUserToken(userId: string, token: string): Promise<boolean>;\n\n\n  /**\n   * Save user data to storage.\n   * @param userId The user ID.\n   */\n  save(userId: string): void;\n\n  /**\n   * Immediately save user data to storage.\n   * @param userId The user ID.\n   */\n  saveImmediate(userId: string): void;\n\n  /**\n   * Get all user IDs.\n   * @returns An async generator of user IDs.\n   */\n  userIds(): Promise<Generator<string, void, void>>;\n\n  /**\n   * Get the user directory path.\n   * @param userId The user ID.\n   * @returns The user directory path.\n   */\n  getUserDirectory(userId: string): Promise<string>;\n}\n\n/**\n * Nitrobase User Management Class.\n * Manages user data and authentication.\n */\nexport class NitrobaseUserManagement<TUser extends JsonObject> implements NitrobaseUserManagementInterface<TUser> {\n\n  /**\n   * Default Nitrobase store IDs used by this class.\n   */\n  static readonly nitrobaseIds = {\n    userList: {\n      name: 'user-list',\n      region: Region.Managers,\n      schemaVer: 1,\n    } as Readonly<StoreFileId>,\n\n    userInfo: {\n      name: 'user-info',\n      region: Region.PerUser,\n    } as Readonly<StoreFileId>,\n  } as const;\n\n  /**\n   * Initialize the user management module.\n   * @param nitrobase The Nitrobase instance.\n   */\n  static async initialize(nitrobase: AlwatrNitrobase): Promise<void> {\n    logger.logMethod?.('NitrobaseUserManagement.initialize');\n    nitrobase.newCollection(this.nitrobaseIds.userList);\n  }\n\n  protected logger_ = createLogger('user-management');\n\n  protected userListCollection_;\n\n  /**\n   * Create a new instance of NitrobaseUserManagement.\n   * @param nitrobase_ The Nitrobase instance.\n   */\n  constructor(\n    protected readonly nitrobase_: AlwatrNitrobase,\n  ) {\n    this.logger_.logMethod?.('constructor');\n    this.userListCollection_ = this.nitrobase_.openCollection(NitrobaseUserManagement.nitrobaseIds.userList);\n  }\n\n\n\n  // Implementation of NitrobaseUserManagementInterface methods with JSDoc comments\n\n  async newUser(user: NewUser<TUser>): Promise<void> {\n    this.logger_.logMethodArgs?.('newUser', user);\n\n    (await this.userListCollection_).addItem(user.userId, {});\n\n    this.newUserInfoDocument_(user.userId, user.data);\n\n    await this.makeTokenFile_(user.userId, user.userToken, user.isManager);\n  }\n\n  async hasUser(userId: string): Promise<boolean> {\n    const userExists = (await this.userListCollection_).hasItem(userId);\n    this.logger_.logMethodFull?.('hasUser', {userId}, userExists);\n    return userExists;\n  }\n\n  async getUserData(userId: string): Promise<TUser> {\n    this.logger_.logMethodArgs?.('getUserData', userId);\n    const userInfoDocument = await this.openUserInfoDocument_(userId);\n    return userInfoDocument.getData();\n  }\n\n  async getUserMeta(userId: string): Promise<Readonly<StoreFileMeta>> {\n    this.logger_.logMethodArgs?.('getUserMeta', userId);\n    const document = await this.openUserInfoDocument_(userId);\n    return document.getStoreMeta();\n  }\n\n  save(userId: string): void {\n    this.logger_.logMethodArgs?.('save', userId);\n    this.openUserInfoDocument_(userId).then((document) => {\n      document.save();\n    });\n  }\n\n  saveImmediate(userId: string): void {\n    this.logger_.logMethodArgs?.('saveImmediate', userId);\n    this.openUserInfoDocument_(userId).then((document) => {\n      document.saveImmediate();\n    });\n  }\n\n  async userIds(): Promise<Generator<string, void, void>> {\n    return (await this.userListCollection_).ids();\n  }\n\n  async verifyUserToken(userId: string, token: string): Promise<boolean> {\n    const tokenFileExist = existsSync(await this.getUserTokenFilePath_(userId, token));\n    this.logger_.logMethodFull?.('verifyUserToken', {userId, token: token.slice(0, 12) + '...'}, tokenFileExist);\n    return tokenFileExist;\n  }\n\n  async getUserDirectory(userId: string): Promise<string> {\n    const userInfoDocument = await this.openUserInfoDocument_(userId);\n    const userDirectoryPath = dirname(resolve(this.nitrobase_.config.rootPath, userInfoDocument.path));\n    this.logger_.logMethodFull?.('getUserDirectory', {userId}, userDirectoryPath);\n    return userDirectoryPath;\n  }\n\n  /**\n   * Create a new user info document.\n   * @param userId The user ID.\n   * @param userInfo The user info data.\n   */\n  protected newUserInfoDocument_(userId: string, userInfo: TUser): void {\n    this.logger_.logMethodArgs?.('newUserInfoDocument', {userId, userInfo});\n    const storeId: StoreFileId = {\n      ...NitrobaseUserManagement.nitrobaseIds.userInfo,\n      ownerId: userId,\n    };\n    if (this.nitrobase_.hasStore(storeId)) {\n      this.logger_.accident?.('newUserInfoDocument_', 'store_already_exists', storeId);\n      return;\n    }\n    this.nitrobase_.newDocument<TUser>(storeId, userInfo);\n  }\n\n  /**\n   * Open the user info document.\n   * @param userId The user ID.\n   * @returns A promise resolving to the user info document.\n   */\n  protected openUserInfoDocument_(userId: string): Promise<DocumentReference<TUser>> {\n    this.logger_.logMethodArgs?.('openUserInfoDocument_', userId);\n    return this.nitrobase_.openDocument<TUser>({\n      ...NitrobaseUserManagement.nitrobaseIds.userInfo,\n      ownerId: userId,\n    });\n  }\n\n  /**\n   * Create a token file for the user.\n   * @param userId The user ID.\n   * @param token The user token.\n   * @param isManager Whether the user is a manager.\n   */\n  protected async makeTokenFile_(userId: string, token: string, isManager?: true): Promise<void> {\n    this.logger_.logMethodArgs?.('makeTokenFile', {userId, token: token.slice(0, 12) + '...', isManager});\n    const userDirectory = await this.getUserDirectory(userId);\n\n    await makeEmptyFile(resolve(userDirectory, `.token/${token}.asn`));\n\n    if (isManager === true) {\n      await makeEmptyFile(resolve(userDirectory, '.auth/manager.asn'));\n    }\n  }\n\n  /**\n   * Get the path to the user token file.\n   * @param userId The user ID.\n   * @param token The user token.\n   * @returns The path to the user token file.\n   */\n  protected async getUserTokenFilePath_(userId: string, token: string): Promise<string> {\n    const userTokenFilePath = resolve(await this.getUserDirectory(userId), `.token/${token}.asn`);\n    this.logger_.logMethodFull?.('getTokenFilePath', {userId, token: token.slice(0, 12) + '...'}, userTokenFilePath);\n    return userTokenFilePath;\n  }\n}\n", "import {createLogger, packageTracer} from '@alwatr/nanolib';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\nexport const logger = /* #__PURE__ */ createLogger(__package_name__);\n"],
+  "mappings": ";;;AAAA,SAAQ,SAAS,eAAc;AAE/B,SAAQ,gBAAAA,qBAAmB;AAC3B,SAAQ,YAAY,qBAAoB;AACxC,SAAQ,cAAoE;;;ACJ5E,SAAQ,cAAc,qBAAoB;AAE1C,aAAc,eAAc,IAAI,qCAAkB,OAAmB;AAE9D,IAAM,SAAyB,6BAAa,mCAAgB;;;ADsF5D,IAAM,2BAAN,MAAM,yBAAqG;AAAA;AAAA;AAAA;AAAA;AAAA,EAmChH,YACqB,YACnB;AADmB;AATrB,SAAU,UAAUC,cAAa,iBAAiB;AAWhD,SAAK,QAAQ,YAAY,aAAa;AACtC,SAAK,sBAAsB,KAAK,WAAW,eAAe,yBAAwB,aAAa,QAAQ;AAAA,EACzG;AAAA;AAAA;AAAA;AAAA;AAAA,EAlBA,aAAa,WAAW,WAA2C;AACjE,WAAO,YAAY,oCAAoC;AACvD,cAAU,cAAc,KAAK,aAAa,QAAQ;AAAA,EACpD;AAAA;AAAA,EAqBA,MAAM,QAAQ,MAAqC;AACjD,SAAK,QAAQ,gBAAgB,WAAW,IAAI;AAE5C,KAAC,MAAM,KAAK,qBAAqB,QAAQ,KAAK,QAAQ,CAAC,CAAC;AAExD,SAAK,qBAAqB,KAAK,QAAQ,KAAK,IAAI;AAEhD,UAAM,KAAK,eAAe,KAAK,QAAQ,KAAK,WAAW,KAAK,SAAS;AAAA,EACvE;AAAA,EAEA,MAAM,QAAQ,QAAkC;AAC9C,UAAM,cAAc,MAAM,KAAK,qBAAqB,QAAQ,MAAM;AAClE,SAAK,QAAQ,gBAAgB,WAAW,EAAC,OAAM,GAAG,UAAU;AAC5D,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,YAAY,QAAgC;AAChD,SAAK,QAAQ,gBAAgB,eAAe,MAAM;AAClD,UAAM,mBAAmB,MAAM,KAAK,sBAAsB,MAAM;AAChE,WAAO,iBAAiB,QAAQ;AAAA,EAClC;AAAA,EAEA,MAAM,YAAY,QAAkD;AAClE,SAAK,QAAQ,gBAAgB,eAAe,MAAM;AAClD,UAAM,WAAW,MAAM,KAAK,sBAAsB,MAAM;AACxD,WAAO,SAAS,aAAa;AAAA,EAC/B;AAAA,EAEA,KAAK,QAAsB;AACzB,SAAK,QAAQ,gBAAgB,QAAQ,MAAM;AAC3C,SAAK,sBAAsB,MAAM,EAAE,KAAK,CAAC,aAAa;AACpD,eAAS,KAAK;AAAA,IAChB,CAAC;AAAA,EACH;AAAA,EAEA,cAAc,QAAsB;AAClC,SAAK,QAAQ,gBAAgB,iBAAiB,MAAM;AACpD,SAAK,sBAAsB,MAAM,EAAE,KAAK,CAAC,aAAa;AACpD,eAAS,cAAc;AAAA,IACzB,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,UAAkD;AACtD,YAAQ,MAAM,KAAK,qBAAqB,IAAI;AAAA,EAC9C;AAAA,EAEA,MAAM,gBAAgB,QAAgB,OAAiC;AACrE,UAAM,iBAAiB,WAAW,MAAM,KAAK,sBAAsB,QAAQ,KAAK,CAAC;AACjF,SAAK,QAAQ,gBAAgB,mBAAmB,EAAC,QAAQ,OAAO,MAAM,MAAM,GAAG,EAAE,IAAI,MAAK,GAAG,cAAc;AAC3G,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,iBAAiB,QAAiC;AACtD,UAAM,mBAAmB,MAAM,KAAK,sBAAsB,MAAM;AAChE,UAAM,oBAAoB,QAAQ,QAAQ,KAAK,WAAW,OAAO,UAAU,iBAAiB,IAAI,CAAC;AACjG,SAAK,QAAQ,gBAAgB,oBAAoB,EAAC,OAAM,GAAG,iBAAiB;AAC5E,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,qBAAqB,QAAgB,UAAuB;AACpE,SAAK,QAAQ,gBAAgB,uBAAuB,EAAC,QAAQ,SAAQ,CAAC;AACtE,UAAM,UAAuB;AAAA,MAC3B,GAAG,yBAAwB,aAAa;AAAA,MACxC,SAAS;AAAA,IACX;AACA,QAAI,KAAK,WAAW,SAAS,OAAO,GAAG;AACrC,WAAK,QAAQ,WAAW,wBAAwB,wBAAwB,OAAO;AAC/E;AAAA,IACF;AACA,SAAK,WAAW,YAAmB,SAAS,QAAQ;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,sBAAsB,QAAmD;AACjF,SAAK,QAAQ,gBAAgB,yBAAyB,MAAM;AAC5D,WAAO,KAAK,WAAW,aAAoB;AAAA,MACzC,GAAG,yBAAwB,aAAa;AAAA,MACxC,SAAS;AAAA,IACX,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAgB,eAAe,QAAgB,OAAe,WAAiC;AAC7F,SAAK,QAAQ,gBAAgB,iBAAiB,EAAC,QAAQ,OAAO,MAAM,MAAM,GAAG,EAAE,IAAI,OAAO,UAAS,CAAC;AACpG,UAAM,gBAAgB,MAAM,KAAK,iBAAiB,MAAM;AAExD,UAAM,cAAc,QAAQ,eAAe,UAAU,KAAK,MAAM,CAAC;AAEjE,QAAI,cAAc,MAAM;AACtB,YAAM,cAAc,QAAQ,eAAe,mBAAmB,CAAC;AAAA,IACjE;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAgB,sBAAsB,QAAgB,OAAgC;AACpF,UAAM,oBAAoB,QAAQ,MAAM,KAAK,iBAAiB,MAAM,GAAG,UAAU,KAAK,MAAM;AAC5F,SAAK,QAAQ,gBAAgB,oBAAoB,EAAC,QAAQ,OAAO,MAAM,MAAM,GAAG,EAAE,IAAI,MAAK,GAAG,iBAAiB;AAC/G,WAAO;AAAA,EACT;AACF;AAAA;AAAA;AAAA;AApKa,yBAKK,eAAe;AAAA,EAC7B,UAAU;AAAA,IACR,MAAM;AAAA,IACN,QAAQ,OAAO;AAAA,IACf,WAAW;AAAA,EACb;AAAA,EAEA,UAAU;AAAA,IACR,MAAM;AAAA,IACN,QAAQ,OAAO;AAAA,EACjB;AACF;AAhBK,IAAM,0BAAN;",
+  "names": ["createLogger", "createLogger"]
+}

package/dist/user-management.d.ts

@@ -0,0 +1,129 @@
+import { type AlwatrAuth, type StoreFileId, type StoreFileMeta } from '@alwatr/nitrobase-types';
+import type { AlwatrNitrobase } from '@alwatr/nitrobase-engine';
+import type { DocumentReference } from '@alwatr/nitrobase-reference';
+/**
+ * New user data type.
+ */
+export type NewUser<TUser extends JsonObject> = AlwatrAuth & {
+    data: TUser;
+    isManager?: true;
+};
+/**
+ * Nitrobase User Management Interface.
+ */
+interface NitrobaseUserManagementInterface<TUser extends JsonObject> {
+    /**
+     * Create a new user.
+     * @param user The new user data.
+     */
+    newUser(user: NewUser<TUser>): Promise<void>;
+    /**
+     * Check if a user exists.
+     * @param userId The user ID.
+     * @returns True if the user exists, false otherwise.
+     */
+    hasUser(userId: string): Promise<boolean>;
+    /**
+     * Get user data.
+     * @param userId The user ID.
+     * @returns The user data.
+     */
+    getUserData(userId: string): Promise<TUser>;
+    /**
+     * Get user meta data.
+     * @param userId The user ID.
+     * @returns The user meta data.
+     */
+    getUserMeta(userId: string): Promise<Readonly<StoreFileMeta>>;
+    /**
+     * Verify user token.
+     * @param userId The user ID.
+     * @param token The user token.
+     * @returns True if the token is valid, false otherwise.
+     */
+    verifyUserToken(userId: string, token: string): Promise<boolean>;
+    /**
+     * Save user data to storage.
+     * @param userId The user ID.
+     */
+    save(userId: string): void;
+    /**
+     * Immediately save user data to storage.
+     * @param userId The user ID.
+     */
+    saveImmediate(userId: string): void;
+    /**
+     * Get all user IDs.
+     * @returns An async generator of user IDs.
+     */
+    userIds(): Promise<Generator<string, void, void>>;
+    /**
+     * Get the user directory path.
+     * @param userId The user ID.
+     * @returns The user directory path.
+     */
+    getUserDirectory(userId: string): Promise<string>;
+}
+/**
+ * Nitrobase User Management Class.
+ * Manages user data and authentication.
+ */
+export declare class NitrobaseUserManagement<TUser extends JsonObject> implements NitrobaseUserManagementInterface<TUser> {
+    protected readonly nitrobase_: AlwatrNitrobase;
+    /**
+     * Default Nitrobase store IDs used by this class.
+     */
+    static readonly nitrobaseIds: {
+        readonly userList: Readonly<StoreFileId>;
+        readonly userInfo: Readonly<StoreFileId>;
+    };
+    /**
+     * Initialize the user management module.
+     * @param nitrobase The Nitrobase instance.
+     */
+    static initialize(nitrobase: AlwatrNitrobase): Promise<void>;
+    protected logger_: import("@alwatr/logger").AlwatrLogger;
+    protected userListCollection_: Promise<import("@alwatr/nitrobase-reference").CollectionReference<import("@alwatr/type-helper").JsonObject>>;
+    /**
+     * Create a new instance of NitrobaseUserManagement.
+     * @param nitrobase_ The Nitrobase instance.
+     */
+    constructor(nitrobase_: AlwatrNitrobase);
+    newUser(user: NewUser<TUser>): Promise<void>;
+    hasUser(userId: string): Promise<boolean>;
+    getUserData(userId: string): Promise<TUser>;
+    getUserMeta(userId: string): Promise<Readonly<StoreFileMeta>>;
+    save(userId: string): void;
+    saveImmediate(userId: string): void;
+    userIds(): Promise<Generator<string, void, void>>;
+    verifyUserToken(userId: string, token: string): Promise<boolean>;
+    getUserDirectory(userId: string): Promise<string>;
+    /**
+     * Create a new user info document.
+     * @param userId The user ID.
+     * @param userInfo The user info data.
+     */
+    protected newUserInfoDocument_(userId: string, userInfo: TUser): void;
+    /**
+     * Open the user info document.
+     * @param userId The user ID.
+     * @returns A promise resolving to the user info document.
+     */
+    protected openUserInfoDocument_(userId: string): Promise<DocumentReference<TUser>>;
+    /**
+     * Create a token file for the user.
+     * @param userId The user ID.
+     * @param token The user token.
+     * @param isManager Whether the user is a manager.
+     */
+    protected makeTokenFile_(userId: string, token: string, isManager?: true): Promise<void>;
+    /**
+     * Get the path to the user token file.
+     * @param userId The user ID.
+     * @param token The user token.
+     * @returns The path to the user token file.
+     */
+    protected getUserTokenFilePath_(userId: string, token: string): Promise<string>;
+}
+export {};
+//# sourceMappingURL=user-management.d.ts.map

package/dist/user-management.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-management.d.ts","sourceRoot":"","sources":["../src/user-management.ts"],"names":[],"mappings":"AAIA,OAAO,EAAS,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,KAAK,aAAa,EAAC,MAAM,yBAAyB,CAAC;AAItG,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,0BAA0B,CAAC;AAC9D,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,6BAA6B,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,KAAK,SAAS,UAAU,IAAI,UAAU,GAAG;IAC3D,IAAI,EAAE,KAAK,CAAC;IACZ,SAAS,CAAC,EAAE,IAAI,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,UAAU,gCAAgC,CAAC,KAAK,SAAS,UAAU;IAEjE;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE1C;;;;OAIG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAE5C;;;;OAIG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC;IAE9D;;;;;OAKG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAGjE;;;OAGG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAElD;;;;OAIG;IACH,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACnD;AAED;;;GAGG;AACH,qBAAa,uBAAuB,CAAC,KAAK,SAAS,UAAU,CAAE,YAAW,gCAAgC,CAAC,KAAK,CAAC;IAoC7G,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,eAAe;IAlChD;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,YAAY;2BAKrB,QAAQ,CAAC,WAAW,CAAC;2BAKrB,QAAQ,CAAC,WAAW,CAAC;MACjB;IAEX;;;OAGG;WACU,UAAU,CAAC,SAAS,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAKlE,SAAS,CAAC,OAAO,wCAAmC;IAEpD,SAAS,CAAC,mBAAmB,+GAAC;IAE9B;;;OAGG;gBAEkB,UAAU,EAAE,eAAe;IAU1C,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAU5C,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAMzC,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAM3C,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IAMnE,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAO1B,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAO7B,OAAO,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAIjD,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAMhE,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAOvD;;;;OAIG;IACH,SAAS,CAAC,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,GAAG,IAAI;IAarE;;;;OAIG;IACH,SAAS,CAAC,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAQlF;;;;;OAKG;cACa,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAW9F;;;;;OAKG;cACa,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAKtF"}