@api-client/core 0.19.16 → 0.19.18

package/src/sdk/UsersSdk.ts

@@ -7,7 +7,7 @@ import {
   SdkOptions,
 } from './SdkBase.js'
 import { RouteBuilder } from './RouteBuilder.js'
-import { IUser } from '../models/store/User.js'
+import { UserSchema } from '../models/store/User.js'
 import { Exception } from '../exceptions/exception.js'
 
 export interface IJwtInfo {
@@ -51,7 +51,7 @@ export interface IJwtUser {
   hd?: string
 }
 
-export interface IRegistrationInfo {
+export interface RegistrationInfoSchema {
   reason: 'new-organization' | 'existing-organization'
   /**
    * The decoded JWT user information.
@@ -60,7 +60,7 @@ export interface IRegistrationInfo {
   user: IJwtInfo
 }
 
-export interface IOrganizationRegistrationInfo extends IRegistrationInfo {
+export interface OrganizationRegistrationInfoSchema extends RegistrationInfoSchema {
   reason: 'new-organization'
   /**
    * The name of the organization to create for the user.
@@ -68,7 +68,7 @@ export interface IOrganizationRegistrationInfo extends IRegistrationInfo {
   organizationName: string
 }
 
-export interface IOrganizationAddUserInfo extends IRegistrationInfo {
+export interface OrganizationAddUserInfoSchema extends RegistrationInfoSchema {
   reason: 'existing-organization'
   /**
    * Set when adding a user to an existing organization.
@@ -85,7 +85,7 @@ export class UsersSdk extends SdkBase {
    * Reads the current user.
    * @param request Optional request options.
    */
-  async me(request: SdkOptions = {}): Promise<IUser> {
+  async me(request: SdkOptions = {}): Promise<UserSchema> {
     const { token } = request
     const url = this.sdk.getUrl(RouteBuilder.usersMe())
     const result = await this.sdk.http.get(url.toString(), { token })
@@ -98,7 +98,7 @@ export class UsersSdk extends SdkBase {
     if (!result.body) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
     }
-    let data: IUser
+    let data: UserSchema
     try {
       data = JSON.parse(result.body)
     } catch {

package/tests/unit/exceptions/exception.spec.ts

@@ -0,0 +1,261 @@
+import { test } from '@japa/runner'
+import { Exception, fromError } from '../../../src/exceptions/exception.js'
+
+test.group('Exceptions > Exception', () => {
+  test('constructor sets basic properties', ({ assert }) => {
+    const ex = new Exception('Test message', { code: 'E_TEST', status: 400, help: 'Help me' })
+    assert.equal(ex.message, 'Test message')
+    assert.equal(ex.code, 'E_TEST')
+    assert.equal(ex.status, 400)
+    assert.equal(ex.help, 'Help me')
+    assert.equal(ex.name, 'Exception')
+  })
+
+  test('constructor uses static defaults', ({ assert }) => {
+    class CustomException extends Exception {
+      static override message = 'Static message'
+      static override code = 'E_STATIC'
+      static override status = 404
+      static override help = 'Static help'
+    }
+    const ex = new CustomException()
+    assert.equal(ex.message, 'Static message')
+    assert.equal(ex.code, 'E_STATIC')
+    assert.equal(ex.status, 404)
+    assert.equal(ex.help, 'Static help')
+    assert.equal(ex.name, 'CustomException')
+  })
+
+  test('constructor defaults status to 500', ({ assert }) => {
+    const ex = new Exception('Test')
+    assert.equal(ex.status, 500)
+  })
+
+  test('constructor accepts status 0', ({ assert }) => {
+    const ex = new Exception('Test', { status: 0 })
+    assert.equal(ex.status, 0)
+  })
+
+  test('setters allow chaining and update properties', ({ assert }) => {
+    const ex = new Exception('Test')
+    const result = ex.setCode('E_CHAIN').setStatus(401).setHelp('Chained')
+
+    assert.strictEqual(result, ex)
+    assert.equal(ex.code, 'E_CHAIN')
+    assert.equal(ex.status, 401)
+    assert.equal(ex.help, 'Chained')
+  })
+
+  test('toString returns properly formatted string', ({ assert }) => {
+    const ex1 = new Exception('Error without code')
+    assert.equal(ex1.toString(), 'Exception: Error without code')
+
+    const ex2 = new Exception('Error with code', { code: 'E_CODE' })
+    assert.equal(ex2.toString(), 'Exception [E_CODE]: Error with code')
+  })
+
+  test('toStringTag returns class name', ({ assert }) => {
+    const ex = new Exception('Test')
+    assert.equal(Object.prototype.toString.call(ex), '[object Exception]')
+
+    class CustomTagError extends Exception {}
+    const ex2 = new CustomTagError('Test')
+    assert.equal(Object.prototype.toString.call(ex2), '[object CustomTagError]')
+  })
+
+  test('toJSON serializes properties', ({ assert }) => {
+    const ex = new Exception('Test message', { code: 'E_TEST', status: 400, help: 'Help me' })
+    const json = ex.toJSON()
+
+    assert.deepEqual(json, {
+      name: 'Exception',
+      message: 'Test message',
+      code: 'E_TEST',
+      status: 400,
+      help: 'Help me',
+    })
+  })
+
+  test('toJSON does not output unset optional properties', ({ assert }) => {
+    const ex = new Exception('Basic')
+    const json = ex.toJSON()
+
+    assert.deepEqual(json, {
+      name: 'Exception',
+      message: 'Basic',
+      status: 500,
+    })
+  })
+
+  test('fromRawException reconstructs exception', ({ assert }) => {
+    const raw = {
+      message: 'Raw message',
+      code: 'E_RAW',
+      status: '403',
+      help: 'Raw help',
+      name: 'RawName',
+    }
+    const ex = Exception.fromRawException(raw, 'Default')
+
+    assert.instanceOf(ex, Exception)
+    assert.equal(ex.message, 'Raw message')
+    assert.equal(ex.code, 'E_RAW')
+    assert.equal(ex.status, 403)
+    assert.equal(ex.help, 'Raw help')
+    assert.equal(ex.name, 'RawName')
+  })
+
+  test('fromRawException uses default message if missing', ({ assert }) => {
+    const ex = Exception.fromRawException({}, 'Fallback message')
+    assert.equal(ex.message, 'Fallback message')
+  })
+})
+
+test.group('Exceptions > Exception > fromError()', () => {
+  test('creates Exception from standard Error', ({ assert }) => {
+    const err = new Error('standard error message')
+    const ex = fromError(err)
+
+    assert.instanceOf(ex, Exception)
+    assert.equal(ex.message, 'standard error message')
+  })
+
+  test('creates Exception from Error with no message', ({ assert }) => {
+    const err = new Error()
+    const ex = fromError(err)
+
+    assert.instanceOf(ex, Exception)
+    assert.equal(ex.message, 'An error occurred')
+  })
+
+  test('copies code property', ({ assert }) => {
+    const err = new Error('test') as unknown as Exception
+    err.code = 'TEST_CODE'
+    const ex = fromError(err)
+
+    assert.equal(ex.code, 'TEST_CODE')
+  })
+
+  test('copies status property', ({ assert }) => {
+    const err = new Error('test') as unknown as Exception
+    err.status = 404
+    const ex = fromError(err)
+
+    assert.equal(ex.status, 404)
+  })
+
+  test('copies help property', ({ assert }) => {
+    const err = new Error('test') as unknown as Exception
+    err.help = 'Help text'
+    const ex = fromError(err)
+
+    assert.equal(ex.help, 'Help text')
+  })
+
+  test('copies name property', ({ assert }) => {
+    const err = new Error('test')
+    err.name = 'CustomErrorName'
+    const ex = fromError(err)
+
+    assert.equal(ex.name, 'CustomErrorName')
+  })
+
+  test('handles when object is already an Exception instance', ({ assert }) => {
+    const originalEx = new Exception('Original exception')
+    originalEx.code = 'ORIGINAL_CODE'
+    originalEx.status = 400
+    originalEx.setHelp('Original help')
+
+    const newEx = fromError(originalEx)
+
+    assert.instanceOf(newEx, Exception)
+    assert.equal(newEx.message, 'Original exception')
+    assert.equal(newEx.code, 'ORIGINAL_CODE')
+    assert.equal(newEx.status, 400)
+    assert.equal(newEx.help, 'Original help')
+    assert.equal(newEx.name, 'Exception')
+  })
+
+  test('uses default message when error has no message', ({ assert }) => {
+    const err = new Error()
+    err.message = ''
+    const ex = fromError(err, { message: 'Default message' })
+
+    assert.equal(ex.message, 'Default message')
+  })
+
+  test('error message takes precedence over default message', ({ assert }) => {
+    const err = new Error('Original message')
+    const ex = fromError(err, { message: 'Default message' })
+
+    assert.equal(ex.message, 'Original message')
+  })
+
+  test('uses default code when error has no code', ({ assert }) => {
+    const err = new Error('test')
+    const ex = fromError(err, { code: 'DEFAULT_CODE' })
+
+    assert.equal(ex.code, 'DEFAULT_CODE')
+  })
+
+  test('error code takes precedence over default code', ({ assert }) => {
+    const err = new Error('test') as unknown as Exception
+    err.code = 'ORIGINAL_CODE'
+    const ex = fromError(err, { code: 'DEFAULT_CODE' })
+
+    assert.equal(ex.code, 'ORIGINAL_CODE')
+  })
+
+  test('uses default status when error has no status', ({ assert }) => {
+    const err = new Error('test')
+    const ex = fromError(err, { status: 401 })
+
+    assert.equal(ex.status, 401)
+  })
+
+  test('uses default status when error status is invalid', ({ assert }) => {
+    const err = new Error('test') as unknown as Exception
+    err.status = 'invalid' as unknown as number
+    const ex = fromError(err, { status: 403 })
+
+    assert.equal(ex.status, 403)
+  })
+
+  test('error status takes precedence over default status', ({ assert }) => {
+    const err = new Error('test') as unknown as Exception
+    err.status = 404
+    const ex = fromError(err, { status: 401 })
+
+    assert.equal(ex.status, 404)
+  })
+
+  test('uses default help when error has no help', ({ assert }) => {
+    const err = new Error('test')
+    const ex = fromError(err, { help: 'Default help text' })
+
+    assert.equal(ex.help, 'Default help text')
+  })
+
+  test('error help takes precedence over default help', ({ assert }) => {
+    const err = new Error('test') as unknown as Exception
+    err.help = 'Original help text'
+    const ex = fromError(err, { help: 'Default help text' })
+
+    assert.equal(ex.help, 'Original help text')
+  })
+
+  test('uses default name when error has no name', ({ assert }) => {
+    const err = { message: 'test' } as unknown as Error
+    const ex = fromError(err, { name: 'DefaultName' })
+
+    assert.equal(ex.name, 'DefaultName')
+  })
+
+  test('error name takes precedence over default name', ({ assert }) => {
+    const err = new Error('test')
+    err.name = 'OriginalName'
+    const ex = fromError(err, { name: 'DefaultName' })
+
+    assert.equal(ex.name, 'OriginalName')
+  })
+})

package/tests/unit/mocking/current/File.spec.ts

@@ -1,7 +1,7 @@
 import { test } from '@japa/runner'
 import { File } from '../../../../src/mocking/lib/File.js'
 import { FolderKind, ProjectKind } from '../../../../src/models/kinds.js'
-import type { IFile } from '../../../../src/models/store/File.js'
+import type { FileSchema } from '../../../../src/models/store/File.js'
 
 test.group('File', (group) => {
   let fileMock: File
@@ -18,7 +18,7 @@ test.group('File', (group) => {
   })
 
   test('file(init) allows overriding properties', ({ assert }) => {
-    const init: Partial<IFile> = {
+    const init: Partial<FileSchema> = {
       kind: ProjectKind,
       info: { name: 'My Project' },
     }
@@ -34,7 +34,7 @@ test.group('File', (group) => {
   })
 
   test('files(size, init) allows overriding properties', ({ assert }) => {
-    const init: Partial<IFile> = {
+    const init: Partial<FileSchema> = {
       kind: ProjectKind,
     }
     const result = fileMock.files(3, init)
@@ -51,7 +51,7 @@ test.group('File', (group) => {
   })
 
   test('folder(init) allows overriding properties', ({ assert }) => {
-    const init: Partial<IFile> = {
+    const init: Partial<FileSchema> = {
       key: 'custom-folder-key',
     }
     const result = fileMock.folder(init)
@@ -66,7 +66,7 @@ test.group('File', (group) => {
   })
 
   test('folders(size, init) allows overriding properties', ({ assert }) => {
-    const init: Partial<IFile> = {
+    const init: Partial<FileSchema> = {
       key: 'batch-key',
     }
     const result = fileMock.folders(3, init)

package/tests/unit/mocking/current/Organization.spec.ts

@@ -1,7 +1,7 @@
 import { test } from '@japa/runner'
 import { Organization } from '../../../../src/mocking/lib/Organization.js'
 import { OrganizationKind } from '../../../../src/models/kinds.js'
-import type { IOrganization } from '../../../../src/models/store/Organization.js'
+import type { OrganizationSchema } from '../../../../src/models/store/Organization.js'
 
 test.group('Organization', (group) => {
   let organization: Organization
@@ -19,10 +19,11 @@ test.group('Organization', (group) => {
     assert.property(result, 'createdBy')
     assert.property(result, 'createdDate')
     assert.property(result, 'grantType')
+    assert.property(result, 'slug')
   })
 
   test('organization(init) allows overriding properties', ({ assert }) => {
-    const init: Partial<IOrganization> = {
+    const init: Partial<OrganizationSchema> = {
       key: 'custom-org-key',
       name: 'Custom Org',
     }
@@ -38,7 +39,7 @@ test.group('Organization', (group) => {
   })
 
   test('organizations(size, init) allows overriding properties', ({ assert }) => {
-    const init: Partial<IOrganization> = {
+    const init: Partial<OrganizationSchema> = {
       name: 'Batch Org',
     }
     const result = organization.organizations(3, init)

package/tests/unit/mocking/current/Permission.spec.ts

@@ -1,7 +1,7 @@
 import { test } from '@japa/runner'
 import { Permission } from '../../../../src/mocking/lib/Permission.js'
 import { Kind as PermissionKind } from '../../../../src/models/store/Permission.js'
-import type { IPermission } from '../../../../src/models/store/Permission.js'
+import type { PermissionSchema } from '../../../../src/models/store/Permission.js'
 
 test.group('permission()', (group) => {
   let permission: Permission
@@ -29,7 +29,7 @@ test.group('permission()', (group) => {
     ])
     .run(({ assert }, { property, type }) => {
       const result = permission.permission()
-      assert.typeOf(result[property as keyof IPermission], type)
+      assert.typeOf(result[property as keyof PermissionSchema], type)
     })
 
   test('has the correct kind', ({ assert }) => {

package/tests/unit/mocking/current/User.spec.ts

@@ -1,7 +1,7 @@
 import { test } from '@japa/runner'
 import { User } from '../../../../src/mocking/lib/User.js'
 import { Kind as UserKind } from '../../../../src/models/store/User.js'
-import type { IUser } from '../../../../src/index.js'
+import type { UserSchema } from '../../../../src/index.js'
 
 test.group('user()', (group) => {
   let user: User
@@ -25,7 +25,7 @@ test.group('user()', (group) => {
     ])
     .run(({ assert }, { property, type }) => {
       const result = user.user()
-      assert.typeOf(result[property as keyof IUser], type)
+      assert.typeOf(result[property as keyof UserSchema], type)
     })
 
   test('has the kind', ({ assert }) => {

package/tests/unit/modeling/domain_file.spec.ts

@@ -1,5 +1,5 @@
 import { test } from '@japa/runner'
-import { DomainFile, IDomainFile, ThingKind, DomainFileKind, DataDomain } from '../../../src/index.js'
+import { DomainFile, type DomainFileSchema, ThingKind, DomainFileKind, DataDomain } from '../../../src/index.js'
 
 test.group('DomainFile.fromDataDomain()', () => {
   test('sets the kind', ({ assert }) => {
@@ -36,7 +36,7 @@ test.group('constructor()', () => {
   })
 
   test('creates a data file from the schema values', ({ assert }) => {
-    const schema: IDomainFile = {
+    const schema: DomainFileSchema = {
       kind: DomainFileKind,
       info: {
         kind: ThingKind,
@@ -74,7 +74,7 @@ test.group('constructor()', () => {
   })
 
   test('creates a data file from the JSON schema string', ({ assert }) => {
-    const schema: IDomainFile = {
+    const schema: DomainFileSchema = {
       kind: DomainFileKind,
       info: {
         kind: ThingKind,

package/tests/unit/models/File/createFileCapabilities.spec.ts

@@ -1,5 +1,5 @@
 import { test } from '@japa/runner'
-import { File, Folder, ICapabilities, PermissionRole, Project } from '../../../../src/index.js'
+import { File, Folder, CapabilitiesSchema, PermissionRole, Project } from '../../../../src/index.js'
 
 test.group('File.createFileCapabilities()', () => {
   test('{$i} correctly sets file capabilities')
@@ -68,7 +68,7 @@ test.group('File.createFileCapabilities()', () => {
     .run(({ assert }, row) => {
       const file = new Project()
       const result = File.createFileCapabilities(file, row[1] as PermissionRole)
-      const key = row[0] as keyof ICapabilities
+      const key = row[0] as keyof CapabilitiesSchema
       assert.strictEqual(result[key], row[2])
     })
 
@@ -138,7 +138,7 @@ test.group('File.createFileCapabilities()', () => {
     .run(({ assert }, row) => {
       const file = new Folder()
       const result = File.createFileCapabilities(file, row[1] as PermissionRole)
-      const key = row[0] as keyof ICapabilities
+      const key = row[0] as keyof CapabilitiesSchema
       assert.strictEqual(result[key], row[2])
     })
 })

package/tests/unit/models/File/new.spec.ts

@@ -1,9 +1,9 @@
 import { test } from '@japa/runner'
-import { File, ThingKind, IFile } from '../../../../src/index.js'
+import { File, ThingKind, FileSchema } from '../../../../src/index.js'
 
 test.group('File.new()', (group) => {
   let file: File
-  let base: IFile
+  let base: FileSchema
   group.each.setup(async () => {
     file = new File()
     base = {

package/tests/unit/models/File/setDeleted.spec.ts

@@ -1,8 +1,8 @@
 import { test } from '@japa/runner'
-import { File, IUser } from '../../../../src/index.js'
+import { File, UserSchema } from '../../../../src/index.js'
 
 test.group('File.setDeleted()', () => {
-  const user: IUser = {
+  const user: UserSchema = {
     key: '123',
     kind: 'Core#User',
     name: 'a1',
@@ -59,7 +59,7 @@ test.group('File.setDeleted()', () => {
 })
 
 test.group('File::setDeleted()', () => {
-  const user: IUser = {
+  const user: UserSchema = {
     key: '123',
     kind: 'Core#User',
     name: 'a1',

package/tests/unit/models/File/setLastModified.spec.ts

@@ -1,8 +1,8 @@
 import { test } from '@japa/runner'
-import { File, IUser } from '../../../../src/index.js'
+import { File, UserSchema } from '../../../../src/index.js'
 
 test.group('File.setLastModified()', () => {
-  const user: IUser = {
+  const user: UserSchema = {
     key: '123',
     kind: 'Core#User',
     name: 'a1',
@@ -53,7 +53,7 @@ test.group('File.setLastModified()', () => {
 })
 
 test.group('File::setLastModified()', () => {
-  const user: IUser = {
+  const user: UserSchema = {
     key: '123',
     kind: 'Core#User',
     name: 'a1',

package/tests/unit/models/File/toJSON.spec.ts

@@ -1,9 +1,9 @@
 import { test } from '@japa/runner'
-import { File, ThingKind, IFile } from '../../../../src/index.js'
+import { File, ThingKind, FileSchema } from '../../../../src/index.js'
 
 test.group('File.toJSON()', (group) => {
   let file: File
-  let base: IFile
+  let base: FileSchema
 
   group.each.setup(() => {
     file = new File()

package/tests/unit/models/Folder/create.spec.ts

@@ -1,5 +1,5 @@
 import { test } from '@japa/runner'
-import { Folder, FolderKind, IFolder, ThingKind } from '../../../../src/index.js'
+import { Folder, FolderKind, FolderSchema, ThingKind } from '../../../../src/index.js'
 
 test.group('Folder.fromName()', () => {
   test('sets the kind', ({ assert }) => {
@@ -22,7 +22,7 @@ test.group('Folder.constructor()', () => {
   })
 
   test('creates a Folder from the schema values', ({ assert }) => {
-    const schema: IFolder = {
+    const schema: FolderSchema = {
       kind: FolderKind,
       info: {
         kind: ThingKind,
@@ -60,7 +60,7 @@ test.group('Folder.constructor()', () => {
   })
 
   test('creates a Folder from the JSON schema string', ({ assert }) => {
-    const schema: IFolder = {
+    const schema: FolderSchema = {
       kind: FolderKind,
       info: {
         kind: ThingKind,

package/tests/unit/models/Permission/all.spec.ts

@@ -1,5 +1,5 @@
 import { test } from '@japa/runner'
-import { IPermission, Permission, PermissionKind, PermissionRole } from '../../../../src/index.js'
+import { PermissionSchema, Permission, PermissionKind, PermissionRole } from '../../../../src/index.js'
 
 test.group('Permission', () => {
   test('creates a default Permission', ({ assert }) => {
@@ -16,7 +16,7 @@ test.group('Permission', () => {
   })
 
   test('creates permissions from the schema', ({ assert }) => {
-    const schema: IPermission = {
+    const schema: PermissionSchema = {
       kind: PermissionKind,
       key: '1',
       addingUser: '2',
@@ -44,7 +44,7 @@ test.group('Permission', () => {
   })
 
   test('creates permissions from the JSON schema', ({ assert }) => {
-    const schema: IPermission = {
+    const schema: PermissionSchema = {
       kind: PermissionKind,
       key: '1',
       addingUser: '2',

package/tests/unit/models/store/Invitation.spec.ts

@@ -1,5 +1,5 @@
 import { test } from '@japa/runner'
-import { Invitation, InvitationKind, type InvitationSchema, type IDeletion } from '../../../../src/index.js'
+import { Invitation, InvitationKind, type InvitationSchema, type DeletionSchema } from '../../../../src/index.js'
 import { OperationType } from '@api-client/json/patch/types.js'
 
 const baseInput: Partial<InvitationSchema> = {
@@ -56,7 +56,7 @@ test.group('Invitation', (group) => {
   })
 
   test('toJSON() serializes all properties correctly', ({ assert }) => {
-    const deletionInfo: IDeletion = { time: Date.now(), user: 'deleter-id', byMe: false, name: 'Deleter' }
+    const deletionInfo: DeletionSchema = { time: Date.now(), user: 'deleter-id', byMe: false, name: 'Deleter' }
     const input: Partial<InvitationSchema> = {
       ...baseInput,
       key: 'inv-key-json',