@forklaunch/interfaces-iam 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 forklaunch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/index.ts

@@ -0,0 +1,4 @@
+export * from './interfaces/organization.service.interface';
+export * from './interfaces/permission.service.interface';
+export * from './interfaces/role.service.interface';
+export * from './interfaces/user.service.interface';

package/interfaces/organization.service.interface.ts

@@ -0,0 +1,45 @@
+import { IdDto, RecordTimingDto } from '@forklaunch/common';
+import { EntityManager } from '@mikro-orm/core';
+import { UserDto } from './user.service.interface';
+
+export type CreateOrganizationDto = {
+  name: string;
+  domain: string;
+  subscription: string;
+  logoUrl?: string;
+  extraFields?: unknown;
+};
+export type UpdateOrganizationDto = IdDto & Partial<CreateOrganizationDto>;
+export type OrganizationDto<OrganizationStatus> = IdDto &
+  CreateOrganizationDto &
+  Partial<RecordTimingDto> & {
+    users: UserDto[];
+    status: OrganizationStatus[keyof OrganizationStatus];
+  };
+
+export type OrganizationServiceParameters<OrganizationStatus> = {
+  CreateOrganizationDto: CreateOrganizationDto;
+  OrganizationDto: OrganizationDto<OrganizationStatus>;
+  UpdateOrganizationDto: UpdateOrganizationDto;
+  IdDto: IdDto;
+};
+
+export interface OrganizationService<
+  OrganizationStatus,
+  Params extends
+    OrganizationServiceParameters<OrganizationStatus> = OrganizationServiceParameters<OrganizationStatus>
+> {
+  createOrganization(
+    organizationDto: Params['CreateOrganizationDto'],
+    em?: EntityManager
+  ): Promise<Params['OrganizationDto']>;
+  getOrganization(
+    idDto: Params['IdDto'],
+    em?: EntityManager
+  ): Promise<Params['OrganizationDto']>;
+  updateOrganization(
+    organizationDto: Params['UpdateOrganizationDto'],
+    em?: EntityManager
+  ): Promise<Params['OrganizationDto']>;
+  deleteOrganization(idDto: Params['IdDto'], em?: EntityManager): Promise<void>;
+}

package/interfaces/permission.service.interface.ts

@@ -0,0 +1,58 @@
+import { IdDto, IdsDto, RecordTimingDto } from '@forklaunch/common';
+import { EntityManager } from '@mikro-orm/core';
+
+export type CreatePermissionDto = {
+  slug: string;
+  addToRolesIds?: string[];
+  extraFields?: unknown;
+};
+export type UpdatePermissionDto = IdDto &
+  Partial<CreatePermissionDto> & {
+    removeFromRolesIds?: string[];
+  };
+export type PermissionDto = IdDto &
+  Partial<RecordTimingDto> & {
+    slug: string;
+  };
+
+export type PermissionServiceParameters = {
+  CreatePermissionDto: CreatePermissionDto;
+  PermissionDto: PermissionDto;
+  UpdatePermissionDto: UpdatePermissionDto;
+  IdDto: IdDto;
+  IdsDto: IdsDto;
+};
+
+export interface PermissionService<
+  Params extends PermissionServiceParameters = PermissionServiceParameters
+> {
+  createPermission(
+    permissionDto: Params['CreatePermissionDto'],
+    em?: EntityManager
+  ): Promise<Params['PermissionDto']>;
+  createBatchPermissions(
+    permissionDtos: Params['CreatePermissionDto'][],
+    em?: EntityManager
+  ): Promise<Params['PermissionDto'][]>;
+  getPermission(
+    idDto: Params['IdDto'],
+    em?: EntityManager
+  ): Promise<Params['PermissionDto']>;
+  getBatchPermissions(
+    idsDto: Params['IdsDto'],
+    em?: EntityManager
+  ): Promise<Params['PermissionDto'][]>;
+  updatePermission(
+    permissionDto: Params['UpdatePermissionDto'],
+    em?: EntityManager
+  ): Promise<Params['PermissionDto']>;
+  updateBatchPermissions(
+    permissionDtos: Params['UpdatePermissionDto'][],
+    em?: EntityManager
+  ): Promise<Params['PermissionDto'][]>;
+  deletePermission(idDto: Params['IdDto'], em?: EntityManager): Promise<void>;
+  deleteBatchPermissions(
+    idsDto: Params['IdsDto'],
+    em?: EntityManager
+  ): Promise<void>;
+}

package/interfaces/role.service.interface.ts

@@ -0,0 +1,54 @@
+import { IdDto, IdsDto, RecordTimingDto } from '@forklaunch/common';
+import { EntityManager } from '@mikro-orm/core';
+import { PermissionDto } from './permission.service.interface';
+
+export type CreateRoleDto = {
+  name: string;
+  permissionsIds?: PermissionDto[];
+  extraFields?: unknown;
+};
+export type UpdateRoleDto = IdDto & Partial<CreateRoleDto>;
+export type RoleDto = IdDto &
+  Omit<CreateRoleDto, 'permissionsIds'> &
+  Partial<RecordTimingDto> & {
+    permissions: PermissionDto[];
+  };
+
+export type RoleServiceParameters = {
+  CreateRoleDto: CreateRoleDto;
+  RoleDto: RoleDto;
+  UpdateRoleDto: UpdateRoleDto;
+  IdDto: IdDto;
+  IdsDto: IdsDto;
+};
+
+export interface RoleService<
+  Params extends RoleServiceParameters = RoleServiceParameters
+> {
+  createRole(
+    roleDto: Params['CreateRoleDto'],
+    em?: EntityManager
+  ): Promise<Params['RoleDto']>;
+  createBatchRoles(
+    roleDtos: Params['CreateRoleDto'][],
+    em?: EntityManager
+  ): Promise<Params['RoleDto'][]>;
+  getRole(
+    idDto: Params['IdDto'],
+    em?: EntityManager
+  ): Promise<Params['RoleDto']>;
+  getBatchRoles(
+    idsDto: Params['IdsDto'],
+    em?: EntityManager
+  ): Promise<Params['RoleDto'][]>;
+  updateRole(
+    roleDto: Params['UpdateRoleDto'],
+    em?: EntityManager
+  ): Promise<Params['RoleDto']>;
+  updateBatchRoles(
+    roleDtos: Params['UpdateRoleDto'][],
+    em?: EntityManager
+  ): Promise<Params['RoleDto'][]>;
+  deleteRole(idDto: Params['IdDto'], em?: EntityManager): Promise<void>;
+  deleteBatchRoles(idsDto: Params['IdsDto'], em?: EntityManager): Promise<void>;
+}

package/interfaces/user.service.interface.ts

@@ -0,0 +1,73 @@
+import { IdDto, IdsDto, RecordTimingDto } from '@forklaunch/common';
+import { EntityManager } from '@mikro-orm/core';
+import { RoleDto } from './role.service.interface';
+
+export type CreateUserDto = {
+  email: string;
+  password: string;
+  firstName: string;
+  lastName: string;
+  organizationId: string;
+  roleIds: string[];
+  phoneNumber?: string;
+  subscription?: string;
+  extraFields?: unknown;
+};
+export type UpdateUserDto = IdDto &
+  Partial<Omit<CreateUserDto, 'organizationId'>>;
+
+export type UserDto = IdDto &
+  Omit<CreateUserDto, 'roleIds' | 'password' | 'organizationId'> &
+  Partial<RecordTimingDto> & {
+    roles: RoleDto[];
+  };
+
+export type UserServiceParameters = {
+  CreateUserDto: CreateUserDto;
+  UserDto: UserDto;
+  UpdateUserDto: UpdateUserDto;
+  IdDto: IdDto;
+  IdsDto: IdsDto;
+};
+
+export interface UserService<
+  Params extends UserServiceParameters = UserServiceParameters
+> {
+  createUser(
+    userDto: Params['CreateUserDto'],
+    em?: EntityManager
+  ): Promise<Params['UserDto']>;
+  createBatchUsers(
+    userDtos: Params['CreateUserDto'][],
+    em?: EntityManager
+  ): Promise<Params['UserDto'][]>;
+  getUser(
+    idDto: Params['IdDto'],
+    em?: EntityManager
+  ): Promise<Params['UserDto']>;
+  getBatchUsers(
+    idsDto: Params['IdsDto'],
+    em?: EntityManager
+  ): Promise<Params['UserDto'][]>;
+  updateUser(
+    userDto: Params['UpdateUserDto'],
+    em?: EntityManager
+  ): Promise<Params['UserDto']>;
+  updateBatchUsers(
+    userDtos: Params['UpdateUserDto'][],
+    em?: EntityManager
+  ): Promise<Params['UserDto'][]>;
+  deleteUser(idDto: Params['IdDto'], em?: EntityManager): Promise<void>;
+  deleteBatchUsers(idsDto: Params['IdsDto'], em?: EntityManager): Promise<void>;
+
+  verifyHasRole(
+    idDto: Params['IdDto'],
+    roleId: string,
+    em?: EntityManager
+  ): Promise<void>;
+  verifyHasPermission(
+    idDto: Params['IdDto'],
+    permissionId: string,
+    em?: EntityManager
+  ): Promise<void>;
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@forklaunch/interfaces-iam",
+  "version": "0.1.0",
+  "description": "IAM interfaces for forklaunch",
+  "homepage": "https://github.com/forklaunch/forklaunch-js#readme",
+  "bugs": {
+    "url": "https://github.com/forklaunch/forklaunch-js/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/forklaunch/forklaunch-js.git"
+  },
+  "license": "MIT",
+  "author": "Forklift Technologies, Inc.",
+  "main": "server.ts",
+  "dependencies": {
+    "@forklaunch/common": "^0.2.5",
+    "@mikro-orm/core": "^6.4.11"
+  },
+  "devDependencies": {
+    "depcheck": "^1.4.7",
+    "prettier": "^3.5.3",
+    "typedoc": "^0.28.1"
+  },
+  "mikro-orm": {
+    "configPaths": [
+      "./mikro-orm.config.ts",
+      "./dist/mikro-orm.config.js"
+    ]
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist pnpm.lock.yaml node_modules",
+    "docs": "typedoc --out docs *",
+    "format": "prettier --ignore-path=.prettierignore --config .prettierrc '**/*.{ts,tsx,json}' --write",
+    "lint": "eslint . -c eslint.config.mjs",
+    "lint:fix": "eslint . -c eslint.config.mjs --fix",
+    "start": "ENV_FILE_PATH=.env.local NODE_OPTIONS='--import=tsx' node dist/server.js",
+    "start:bun": "bun run migrate:up && bun dist/server.js",
+    "test": "vitest --passWithNoTests"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist"
+  },
+  "exclude": ["node_modules", "dist", "eslint.config.mjs"]
+}