@sneat/auth-models 0.1.0

package/eslint.config.js

@@ -0,0 +1,7 @@
+const baseConfig = require('../../../eslint.config.js');
+const { sneatLibConfig } = require('../../../eslint.lib.config.js');
+
+module.exports = [
+  ...baseConfig,
+  ...sneatLibConfig(__dirname),
+];

package/ng-package.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "../../../node_modules/ng-packagr/ng-package.schema.json",
+  "dest": "../../../dist/libs/auth/models",
+  "lib": {
+    "entryFile": "src/index.ts"
+  }
+}

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@sneat/auth-models",
+  "version": "0.1.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@angular/common": ">=21.0.0",
+    "@angular/core": ">=21.0.0"
+  },
+  "dependencies": {
+    "tslib": "2.8.1"
+  }
+}

package/project.json

@@ -0,0 +1,38 @@
+{
+  "name": "auth-models",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "projectType": "library",
+  "sourceRoot": "libs/auth/models/src",
+  "prefix": "sneat",
+  "targets": {
+    "build": {
+      "executor": "@nx/angular:ng-packagr-lite",
+      "outputs": [
+        "{workspaceRoot}/dist/libs/auth/models"
+      ],
+      "options": {
+        "project": "libs/auth/models/ng-package.json",
+        "tsConfig": "libs/auth/models/tsconfig.lib.json"
+      },
+      "configurations": {
+        "production": {
+          "tsConfig": "libs/auth/models/tsconfig.lib.prod.json"
+        },
+        "development": {}
+      },
+      "defaultConfiguration": "production"
+    },
+    "test": {
+      "executor": "@nx/vitest:test",
+      "outputs": [
+        "{workspaceRoot}/coverage/libs/auth/models"
+      ],
+      "options": {
+        "tsConfig": "libs/auth/models/tsconfig.spec.json"
+      }
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint"
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './lib/avatar';
+export * from './lib/user';
+export * from './lib/person-names';

package/src/lib/avatar.spec.ts

@@ -0,0 +1,8 @@
+import { IAvatar } from './avatar';
+
+describe('auth models sanity', () => {
+  it('should allow creating an IAvatar object', () => {
+    const avatar: IAvatar = { gravatar: 'test' };
+    expect(avatar.gravatar).toBe('test');
+  });
+});

package/src/lib/avatar.ts

@@ -0,0 +1,7 @@
+export interface IAvatar {
+  readonly gravatar?: string;
+  readonly external?: {
+    readonly provider?: string;
+    readonly url?: string;
+  };
+}

package/src/lib/person-names.ts

@@ -0,0 +1,95 @@
+// TODO: Find a proper "non-auth" library for this file
+
+export interface IPersonNames {
+  readonly firstName?: string;
+  readonly lastName?: string;
+  readonly middleName?: string;
+  readonly nickName?: string;
+  readonly fullName?: string;
+}
+
+export function mustHaveAtLeastOneName(names?: IPersonNames): void {
+  if (!names) {
+    throw new Error('Names are required');
+  }
+  if (
+    !names.firstName &&
+    !names.lastName &&
+    !names.middleName &&
+    !names.nickName &&
+    !names.fullName
+  ) {
+    throw new Error('At least one name is required');
+  }
+}
+
+export function namesToUrlParams(names?: IPersonNames): string {
+  if (!names) {
+    return '';
+  }
+  const { firstName, lastName, middleName, nickName, fullName } = names;
+  const params: string[] = [];
+  if (firstName) {
+    params.push(`firstName=${encodeURIComponent(firstName)}`);
+  }
+  if (lastName) {
+    params.push(`lastName=${encodeURIComponent(lastName)}`);
+  }
+  if (middleName) {
+    params.push(`middleName=${encodeURIComponent(middleName)}`);
+  }
+  if (nickName) {
+    params.push(`nickName=${encodeURIComponent(nickName)}`);
+  }
+  if (fullName && fullName !== `${firstName} ${lastName}`) {
+    params.push(`fullName=${encodeURIComponent(fullName)}`);
+  }
+  return params.join('&');
+}
+
+export function isNameEmpty(n?: IPersonNames): boolean {
+  // noinspection UnnecessaryLocalVariableJS
+  const result =
+    !n ||
+    (!n.fullName?.trim() &&
+      !n.firstName?.trim() &&
+      !n.lastName?.trim() &&
+      !n.middleName?.trim() &&
+      !n.nickName?.trim());
+  return result;
+}
+
+export function trimNames(n: IPersonNames): IPersonNames {
+  const first = n.firstName?.trim(),
+    middle = n.middleName?.trim(),
+    last = n.lastName?.trim(),
+    full = n.fullName?.trim();
+  if (
+    first !== n?.firstName ||
+    last !== n?.lastName ||
+    middle != n.middleName ||
+    full != n.fullName
+  ) {
+    n = {
+      firstName: first,
+      middleName: middle,
+      lastName: last,
+      fullName: full,
+    };
+  }
+  return n;
+}
+
+export function getFullName(n: IPersonNames): string {
+  if (n.fullName) {
+    return n.fullName;
+  }
+  return [
+    n.firstName,
+    n.middleName,
+    n.lastName,
+    n.nickName ? `(${n.nickName})` : '',
+  ]
+    .filter((v) => !!v)
+    .join(' ');
+}

package/src/lib/user.ts

@@ -0,0 +1,34 @@
+import { EnumAsUnionOfKeys, SpaceType } from '@sneat/core';
+import { IAvatar } from './avatar';
+import { IPersonNames } from './person-names';
+
+// Does not contain an ID as it's a key.
+// Use IRecord<IUserRecord> to keep record paired with ID
+export interface IUserRecord {
+  readonly accounts?: string[];
+  readonly title: string;
+  readonly countryID?: string;
+  readonly email?: string;
+  readonly emailIsVerified?: boolean;
+  readonly avatar?: IAvatar;
+  readonly spaceIDs?: readonly string[];
+  readonly spaces?: Record<string, IUserSpaceBrief>;
+  readonly names?: IPersonNames;
+}
+
+export enum SpaceMemberTypeEnum {
+  creator = 'creator',
+  member = 'member',
+  pet = 'pet',
+  pupil = 'pupil',
+  staff = 'staff',
+}
+
+export type SpaceMemberType = EnumAsUnionOfKeys<typeof SpaceMemberTypeEnum>;
+
+export interface IUserSpaceBrief {
+  readonly title: string;
+  readonly type: SpaceType;
+  readonly roles: string[];
+  readonly userContactID: string;
+}

package/src/test-setup.ts

@@ -0,0 +1 @@
+import '@sneat/core/testing-light';

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../../../tsconfig.angular.json",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

package/tsconfig.lib.json

@@ -0,0 +1,19 @@
+{
+  "extends": "../../../tsconfig.lib.base.json",
+  "exclude": [
+    "vite.config.ts",
+    "vite.config.mts",
+    "vitest.config.ts",
+    "vitest.config.mts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.test.tsx",
+    "src/**/*.spec.tsx",
+    "src/**/*.test.js",
+    "src/**/*.spec.js",
+    "src/**/*.test.jsx",
+    "src/**/*.spec.jsx",
+    "src/test-setup.ts",
+    "src/lib/testing/**/*"
+  ]
+}

package/tsconfig.lib.prod.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.lib.json",
+  "compilerOptions": {
+    "declarationMap": false
+  },
+  "angularCompilerOptions": {}
+}

package/tsconfig.spec.json

@@ -0,0 +1,31 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../dist/out-tsc",
+    "types": [
+      "vitest/globals",
+      "vitest/importMeta",
+      "vite/client",
+      "node",
+      "vitest"
+    ]
+  },
+  "include": [
+    "vite.config.ts",
+    "vite.config.mts",
+    "vitest.config.ts",
+    "vitest.config.mts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.test.tsx",
+    "src/**/*.spec.tsx",
+    "src/**/*.test.js",
+    "src/**/*.spec.js",
+    "src/**/*.test.jsx",
+    "src/**/*.spec.jsx",
+    "src/**/*.d.ts"
+  ],
+  "files": [
+    "src/test-setup.ts"
+  ]
+}

package/vite.config.mts

@@ -0,0 +1,10 @@
+/// <reference types='vitest' />
+import { defineConfig } from 'vitest/config';
+import { createBaseViteConfig } from '../../../vite.config.base';
+
+export default defineConfig(() =>
+	createBaseViteConfig({
+		dirname: __dirname,
+		name: 'auth-models',
+	}),
+);