refactor: remove Uuid and RoleName from @standardnotes/common in favour of @standardnotes/domain-core value objects (#2167)

2023-01-19 16:17:59 +01:00
parent 2d63b7431a
commit 856a7e3500
108 changed files with 319 additions and 374 deletions
--- a/packages/api/src/Domain/Client/Subscription/SubscriptionApiService.ts
+++ b/packages/api/src/Domain/Client/Subscription/SubscriptionApiService.ts
@@ -10,7 +10,6 @@ import { SubscriptionInviteAcceptResponse } from '../../Response/Subscription/Su

 import { SubscriptionApiServiceInterface } from './SubscriptionApiServiceInterface'
 import { SubscriptionApiOperations } from './SubscriptionApiOperations'
-import { Uuid } from '@standardnotes/common'
 import { AppleIAPConfirmResponse } from './../../Response/Subscription/AppleIAPConfirmResponse'
 import { AppleIAPConfirmRequestParams } from '../../Request'

@@ -83,7 +82,7 @@ export class SubscriptionApiService implements SubscriptionApiServiceInterface {
    }
  }

-  async acceptInvite(inviteUuid: Uuid): Promise<SubscriptionInviteAcceptResponse> {
+  async acceptInvite(inviteUuid: string): Promise<SubscriptionInviteAcceptResponse> {
    if (this.operationsInProgress.get(SubscriptionApiOperations.AcceptingInvite)) {
      throw new ApiCallError(ErrorMessage.GenericInProgress)
    }
--- a/packages/api/src/Domain/Client/Subscription/SubscriptionApiServiceInterface.ts
+++ b/packages/api/src/Domain/Client/Subscription/SubscriptionApiServiceInterface.ts
@@ -1,5 +1,3 @@
-import { Uuid } from '@standardnotes/common'
-
 import { AppleIAPConfirmResponse } from './../../Response/Subscription/AppleIAPConfirmResponse'
 import { AppleIAPConfirmRequestParams } from '../../Request'
 import { SubscriptionInviteAcceptResponse } from '../../Response/Subscription/SubscriptionInviteAcceptResponse'
@@ -10,7 +8,7 @@ import { SubscriptionInviteResponse } from '../../Response/Subscription/Subscrip
 export interface SubscriptionApiServiceInterface {
  invite(inviteeEmail: string): Promise<SubscriptionInviteResponse>
  listInvites(): Promise<SubscriptionInviteListResponse>
-  cancelInvite(inviteUuid: Uuid): Promise<SubscriptionInviteCancelResponse>
-  acceptInvite(inviteUuid: Uuid): Promise<SubscriptionInviteAcceptResponse>
+  cancelInvite(inviteUuid: string): Promise<SubscriptionInviteCancelResponse>
+  acceptInvite(inviteUuid: string): Promise<SubscriptionInviteAcceptResponse>
  confirmAppleIAP(params: AppleIAPConfirmRequestParams): Promise<AppleIAPConfirmResponse>
 }
--- a/packages/api/src/Domain/Client/User/UserApiServiceInterface.ts
+++ b/packages/api/src/Domain/Client/User/UserApiServiceInterface.ts
@@ -1,4 +1,4 @@
-import { UserRequestType, Uuid } from '@standardnotes/common'
+import { UserRequestType } from '@standardnotes/common'
 import { type RootKeyParamsInterface } from '@standardnotes/models'

 import { UserDeletionResponse } from '../../Response/User/UserDeletionResponse'
@@ -12,6 +12,6 @@ export interface UserApiServiceInterface {
    keyParams: RootKeyParamsInterface
    ephemeral: boolean
  }): Promise<UserRegistrationResponse>
-  submitUserRequest(dto: { userUuid: Uuid; requestType: UserRequestType }): Promise<UserRequestResponse>
+  submitUserRequest(dto: { userUuid: string; requestType: UserRequestType }): Promise<UserRequestResponse>
  deleteAccount(userUuid: string): Promise<UserDeletionResponse>
 }
--- a/packages/api/src/Domain/Client/Workspace/WorkspaceApiService.ts
+++ b/packages/api/src/Domain/Client/Workspace/WorkspaceApiService.ts
@@ -1,4 +1,4 @@
-import { Uuid, WorkspaceAccessLevel, WorkspaceType } from '@standardnotes/common'
+import { WorkspaceAccessLevel, WorkspaceType } from '@standardnotes/common'

 import { ErrorMessage } from '../../Error/ErrorMessage'
 import { ApiCallError } from '../../Error/ApiCallError'
@@ -96,7 +96,7 @@ export class WorkspaceApiService implements WorkspaceApiServiceInterface {

  async inviteToWorkspace(dto: {
    inviteeEmail: string
-    workspaceUuid: Uuid
+    workspaceUuid: string
    accessLevel: WorkspaceAccessLevel
  }): Promise<WorkspaceInvitationResponse> {
    this.lockOperation(WorkspaceApiOperations.Inviting)
--- a/packages/api/src/Domain/Client/Workspace/WorkspaceApiServiceInterface.ts
+++ b/packages/api/src/Domain/Client/Workspace/WorkspaceApiServiceInterface.ts
@@ -1,4 +1,4 @@
-import { Uuid, WorkspaceAccessLevel, WorkspaceType } from '@standardnotes/common'
+import { WorkspaceAccessLevel, WorkspaceType } from '@standardnotes/common'

 import { WorkspaceKeyshareInitiatingResponse } from '../../Response/Workspace/WorkspaceKeyshareInitiatingResponse'
 import { WorkspaceCreationResponse } from '../../Response/Workspace/WorkspaceCreationResponse'
@@ -17,20 +17,20 @@ export interface WorkspaceApiServiceInterface {
  }): Promise<WorkspaceCreationResponse>
  inviteToWorkspace(dto: {
    inviteeEmail: string
-    workspaceUuid: Uuid
+    workspaceUuid: string
    accessLevel: WorkspaceAccessLevel
  }): Promise<WorkspaceInvitationResponse>
  acceptInvite(dto: {
-    inviteUuid: Uuid
-    userUuid: Uuid
+    inviteUuid: string
+    userUuid: string
    publicKey: string
    encryptedPrivateKey: string
  }): Promise<WorkspaceInvitationAcceptingResponse>
  listWorkspaces(): Promise<WorkspaceListResponse>
-  listWorkspaceUsers(dto: { workspaceUuid: Uuid }): Promise<WorkspaceUserListResponse>
+  listWorkspaceUsers(dto: { workspaceUuid: string }): Promise<WorkspaceUserListResponse>
  initiateKeyshare(dto: {
-    workspaceUuid: Uuid
-    userUuid: Uuid
+    workspaceUuid: string
+    userUuid: string
    encryptedWorkspaceKey: string
  }): Promise<WorkspaceKeyshareInitiatingResponse>
 }
--- a/packages/api/src/Domain/Client/Workspace/WorkspaceUser.ts
+++ b/packages/api/src/Domain/Client/Workspace/WorkspaceUser.ts
@@ -1,11 +1,11 @@
-import { Uuid, WorkspaceAccessLevel, WorkspaceUserStatus } from '@standardnotes/common'
+import { WorkspaceAccessLevel, WorkspaceUserStatus } from '@standardnotes/common'

 export type WorkspaceUser = {
-  uuid: Uuid
+  uuid: string
  accessLevel: WorkspaceAccessLevel
-  userUuid: Uuid
+  userUuid: string
  userDisplayName: string | null
-  workspaceUuid: Uuid
+  workspaceUuid: string
  encryptedWorkspaceKey: string | null
  publicKey: string | null
  encryptedPrivateKey: string | null
--- a/packages/api/src/Domain/Http/HttpResponseMeta.ts
+++ b/packages/api/src/Domain/Http/HttpResponseMeta.ts
@@ -1,9 +1,8 @@
 import { Role } from '@standardnotes/security'
-import { Uuid } from '@standardnotes/common'

 export type HttpResponseMeta = {
  auth: {
-    userUuid?: Uuid
+    userUuid?: string
    roles?: Role[]
  }
  server: {
--- a/packages/api/src/Domain/Request/Subscription/SubscriptionInviteAcceptRequestParams.ts
+++ b/packages/api/src/Domain/Request/Subscription/SubscriptionInviteAcceptRequestParams.ts
@@ -1,6 +1,4 @@
-import { Uuid } from '@standardnotes/common'
-
 export type SubscriptionInviteAcceptRequestParams = {
-  inviteUuid: Uuid
+  inviteUuid: string
  [additionalParam: string]: unknown
 }
--- a/packages/api/src/Domain/Request/Subscription/SubscriptionInviteCancelRequestParams.ts
+++ b/packages/api/src/Domain/Request/Subscription/SubscriptionInviteCancelRequestParams.ts
@@ -1,10 +1,8 @@
-import { Uuid } from '@standardnotes/common'
-
 import { ApiEndpointParam } from '../ApiEndpointParam'
 import { ApiVersion } from '../../Api/ApiVersion'

 export type SubscriptionInviteCancelRequestParams = {
  [ApiEndpointParam.ApiVersion]: ApiVersion.v0
-  inviteUuid: Uuid
+  inviteUuid: string
  [additionalParam: string]: unknown
 }
--- a/packages/api/src/Domain/Request/Subscription/SubscriptionInviteDeclineRequestParams.ts
+++ b/packages/api/src/Domain/Request/Subscription/SubscriptionInviteDeclineRequestParams.ts
@@ -1,10 +1,8 @@
-import { Uuid } from '@standardnotes/common'
-
 import { ApiEndpointParam } from '../ApiEndpointParam'
 import { ApiVersion } from '../../Api/ApiVersion'

 export type SubscriptionInviteDeclineRequestParams = {
  [ApiEndpointParam.ApiVersion]: ApiVersion.v0
-  inviteUuid: Uuid
+  inviteUuid: string
  [additionalParam: string]: unknown
 }
--- a/packages/api/src/Domain/Request/User/UserDeletionRequestParams.ts
+++ b/packages/api/src/Domain/Request/User/UserDeletionRequestParams.ts
@@ -1,6 +1,4 @@
-import { Uuid } from '@standardnotes/common'
-
 export type UserDeletionRequestParams = {
-  userUuid: Uuid
+  userUuid: string
  [additionalParam: string]: unknown
 }
--- a/packages/api/src/Domain/Request/UserRequest/UserRequestRequestParams.ts
+++ b/packages/api/src/Domain/Request/UserRequest/UserRequestRequestParams.ts
@@ -1,7 +1,7 @@
-import { UserRequestType, Uuid } from '@standardnotes/common'
+import { UserRequestType } from '@standardnotes/common'

 export type UserRequestRequestParams = {
-  userUuid: Uuid
+  userUuid: string
  requestType: UserRequestType
  [additionalParam: string]: unknown
 }
--- a/packages/api/src/Domain/Request/Workspace/WorkspaceInvitationAcceptingRequestParams.ts
+++ b/packages/api/src/Domain/Request/Workspace/WorkspaceInvitationAcceptingRequestParams.ts
@@ -1,8 +1,6 @@
-import { Uuid } from '@standardnotes/common'
-
 export type WorkspaceInvitationAcceptingRequestParams = {
-  inviteUuid: Uuid
-  userUuid: Uuid
+  inviteUuid: string
+  userUuid: string
  publicKey: string
  encryptedPrivateKey: string
  [additionalParam: string]: unknown
--- a/packages/api/src/Domain/Request/Workspace/WorkspaceInvitationRequestParams.ts
+++ b/packages/api/src/Domain/Request/Workspace/WorkspaceInvitationRequestParams.ts
@@ -1,7 +1,7 @@
-import { Uuid, WorkspaceAccessLevel } from '@standardnotes/common'
+import { WorkspaceAccessLevel } from '@standardnotes/common'

 export type WorkspaceInvitationRequestParams = {
-  workspaceUuid: Uuid
+  workspaceUuid: string
  inviteeEmail: string
  accessLevel: WorkspaceAccessLevel
  [additionalParam: string]: unknown
--- a/packages/api/src/Domain/Request/Workspace/WorkspaceKeyshareInitiatingRequestParams.ts
+++ b/packages/api/src/Domain/Request/Workspace/WorkspaceKeyshareInitiatingRequestParams.ts
@@ -1,8 +1,6 @@
-import { Uuid } from '@standardnotes/common'
-
 export type WorkspaceKeyshareInitiatingRequestParams = {
-  userUuid: Uuid
-  workspaceUuid: Uuid
+  userUuid: string
+  workspaceUuid: string
  encryptedWorkspaceKey: string
  [additionalParam: string]: unknown
 }
--- a/packages/api/src/Domain/Request/Workspace/WorkspaceUserListRequestParams.ts
+++ b/packages/api/src/Domain/Request/Workspace/WorkspaceUserListRequestParams.ts
@@ -1,6 +1,4 @@
-import { Uuid } from '@standardnotes/common'
-
 export type WorkspaceUserListRequestParams = {
-  workspaceUuid: Uuid
+  workspaceUuid: string
  [additionalParam: string]: unknown
 }
--- a/packages/api/src/Domain/Response/Subscription/SubscriptionInviteResponseBody.ts
+++ b/packages/api/src/Domain/Response/Subscription/SubscriptionInviteResponseBody.ts
@@ -1,9 +1,7 @@
-import { Uuid } from '@standardnotes/common'
-
 export type SubscriptionInviteResponseBody =
  | {
      success: true
-      sharedSubscriptionInvitationUuid: Uuid
+      sharedSubscriptionInvitationUuid: string
    }
  | {
      success: false
--- a/packages/api/src/Domain/Response/User/UserRegistrationResponseBody.ts
+++ b/packages/api/src/Domain/Response/User/UserRegistrationResponseBody.ts
@@ -1,11 +1,10 @@
-import { Uuid } from '@standardnotes/common'
 import { KeyParamsData, SessionBody } from '@standardnotes/responses'

 export type UserRegistrationResponseBody = {
  session: SessionBody
  key_params: KeyParamsData
  user: {
-    uuid: Uuid
+    uuid: string
    email: string
  }
 }
--- a/packages/api/src/Domain/Server/Subscription/Paths.ts
+++ b/packages/api/src/Domain/Server/Subscription/Paths.ts
@@ -1,10 +1,8 @@
-import { Uuid } from '@standardnotes/common'
-
 const SharingPaths = {
  invite: '/v1/subscription-invites',
-  acceptInvite: (inviteUuid: Uuid) => `/v1/subscription-invites/${inviteUuid}/accept`,
-  declineInvite: (inviteUuid: Uuid) => `/v1/subscription-invites/${inviteUuid}/decline`,
-  cancelInvite: (inviteUuid: Uuid) => `/v1/subscription-invites/${inviteUuid}`,
+  acceptInvite: (inviteUuid: string) => `/v1/subscription-invites/${inviteUuid}/accept`,
+  declineInvite: (inviteUuid: string) => `/v1/subscription-invites/${inviteUuid}/decline`,
+  cancelInvite: (inviteUuid: string) => `/v1/subscription-invites/${inviteUuid}`,
  listInvites: '/v1/subscription-invites',
 }

--- a/packages/api/src/Domain/Server/User/Paths.ts
+++ b/packages/api/src/Domain/Server/User/Paths.ts
@@ -1,8 +1,6 @@
-import { Uuid } from '@standardnotes/common'
-
 const UserPaths = {
  register: '/v1/users',
-  deleteAccount: (userUuid: Uuid) => `/v1/users/${userUuid}`,
+  deleteAccount: (userUuid: string) => `/v1/users/${userUuid}`,
 }

 export const Paths = {
--- a/packages/api/src/Domain/Server/UserRequest/Paths.ts
+++ b/packages/api/src/Domain/Server/UserRequest/Paths.ts
@@ -1,7 +1,5 @@
-import { Uuid } from '@standardnotes/common'
-
 const UserRequestPaths = {
-  submitUserRequest: (userUuid: Uuid) => `/v1/users/${userUuid}/requests`,
+  submitUserRequest: (userUuid: string) => `/v1/users/${userUuid}/requests`,
 }

 export const Paths = {
--- a/packages/api/src/Domain/Server/Workspace/Paths.ts
+++ b/packages/api/src/Domain/Server/Workspace/Paths.ts
@@ -1,13 +1,11 @@
-import { Uuid } from '@standardnotes/common'
-
 const WorkspacePaths = {
  createWorkspace: '/v1/workspaces',
  listWorkspaces: '/v1/workspaces',
-  listWorkspaceUsers: (uuid: Uuid) => `/v1/workspaces/${uuid}/users`,
-  initiateKeyshare: (worksapceUuid: Uuid, userUuid: Uuid) =>
+  listWorkspaceUsers: (uuid: string) => `/v1/workspaces/${uuid}/users`,
+  initiateKeyshare: (worksapceUuid: string, userUuid: string) =>
    `/v1/workspaces/${worksapceUuid}/users/${userUuid}/keyshare`,
-  inviteToWorkspace: (uuid: Uuid) => `/v1/workspaces/${uuid}/invites`,
-  acceptInvite: (uuid: Uuid) => `/v1/invites/${uuid}/accept`,
+  inviteToWorkspace: (uuid: string) => `/v1/workspaces/${uuid}/invites`,
+  acceptInvite: (uuid: string) => `/v1/invites/${uuid}/accept`,
 }

 export const Paths = {