@forklaunch/interfaces-iam 0.1.0 → 0.1.1

package/index.ts

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

package/interfaces/index.ts

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

package/interfaces/organization.service.interface.ts

@@ -1,28 +1,5 @@
-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;
-};
+import { OrganizationServiceParameters } from '../types/organization.service.types';
 
 export interface OrganizationService<
   OrganizationStatus,

package/interfaces/permission.service.interface.ts

@@ -1,27 +1,5 @@
-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;
-};
+import { PermissionServiceParameters } from '../types/permission.service.types';
 
 export interface PermissionService<
   Params extends PermissionServiceParameters = PermissionServiceParameters

package/interfaces/role.service.interface.ts

@@ -1,26 +1,5 @@
-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;
-};
+import { RoleServiceParameters } from '../types/role.service.types';
 
 export interface RoleService<
   Params extends RoleServiceParameters = RoleServiceParameters

package/interfaces/user.service.interface.ts

@@ -1,34 +1,5 @@
-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;
-};
+import { UserServiceParameters } from '../types/user.service.types';
 
 export interface UserService<
   Params extends UserServiceParameters = UserServiceParameters

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forklaunch/interfaces-iam",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "IAM interfaces for forklaunch",
   "homepage": "https://github.com/forklaunch/forklaunch-js#readme",
   "bugs": {
@@ -12,7 +12,6 @@
   },
   "license": "MIT",
   "author": "Forklift Technologies, Inc.",
-  "main": "server.ts",
   "dependencies": {
     "@forklaunch/common": "^0.2.5",
     "@mikro-orm/core": "^6.4.11"
@@ -29,12 +28,13 @@
     ]
   },
   "scripts": {
-    "build": "tsc",
-    "clean": "rm -rf dist pnpm.lock.yaml node_modules",
+    "build": "tsc && pnpm package:eject",
+    "clean": "rm -rf lib 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",
+    "package:eject": "mkdir -p lib/eject && cp -r interfaces lib/eject/interfaces && cp -r types lib/eject/types",
     "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

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

package/types/index.ts

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

package/types/organization.service.types.ts

@@ -0,0 +1,24 @@
+import { IdDto, RecordTimingDto } from '@forklaunch/common';
+import { UserDto } from './user.service.types';
+
+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;
+};

package/types/permission.service.types.ts

@@ -0,0 +1,23 @@
+import { IdDto, IdsDto, RecordTimingDto } from '@forklaunch/common';
+
+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;
+};

package/types/role.service.types.ts

@@ -0,0 +1,22 @@
+import { IdDto, IdsDto, RecordTimingDto } from '@forklaunch/common';
+import { PermissionDto } from './permission.service.types';
+
+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;
+};

package/types/user.service.types.ts

@@ -0,0 +1,30 @@
+import { IdDto, IdsDto, RecordTimingDto } from '@forklaunch/common';
+import { RoleDto } from './role.service.types';
+
+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;
+};