@api-client/core 0.19.17 → 0.19.19

package/src/sdk/SdkMock.ts

@@ -6,11 +6,11 @@ import {
   type InterceptOptions,
   type SerializedRequest,
 } from '@jarrodek/amw'
-import type { IOrganization } from '../models/store/Organization.js'
+import type { OrganizationSchema } from '../models/store/Organization.js'
 import type { GroupSchema } from '../models/store/Group.js'
-import type { IUser } from '../models/store/User.js'
+import type { UserSchema } from '../models/store/User.js'
 import type { InvitationSchema } from '../models/store/Invitation.js'
-import { type IFile, type FileBreadcrumb } from '../models/store/File.js'
+import { type FileSchema, type FileBreadcrumb } from '../models/store/File.js'
 import type { ContextChangeRecord, ContextListResult, IBulkOperationResult } from '../events/BaseEvents.js'
 import type { TrashEntry } from '../models/TrashEntry.js'
 import { RouteBuilder } from './RouteBuilder.js'
@@ -208,7 +208,7 @@ export class SdkMock {
       //   body: JSON.stringify({
       //     items: this.gen.organization.organizations(init?.size ?? 5),
       //     cursor: this.createCursorOption(init),
-      //   } as ContextListResult<IOrganization>),
+      //   } as ContextListResult<OrganizationSchema>),
       // }
       const respond = this.createDefaultResponse(
         200,
@@ -217,7 +217,7 @@ export class SdkMock {
           JSON.stringify({
             items: this.gen.organization.organizations(init?.size ?? 5),
             cursor: this.createCursorOption(init),
-          } as ContextListResult<IOrganization>),
+          } as ContextListResult<OrganizationSchema>),
         init
       )
       await mock.add(
@@ -454,13 +454,13 @@ export class SdkMock {
         //   body: JSON.stringify({
         //     items: this.gen.users.users(init?.size ?? 5),
         //     cursor: this.createCursorOption(init),
-        //   } as ContextListResult<IUser>),
+        //   } as ContextListResult<UserSchema>),
         // }
         const respond = this.createDefaultResponse(
           200,
           { 'content-type': 'application/json' },
           () => {
-            const obj: ContextListResult<IUser> = {
+            const obj: ContextListResult<UserSchema> = {
               items: this.gen.users.users(init?.size ?? 5),
               cursor: this.createCursorOption(init),
             }
@@ -512,7 +512,7 @@ export class SdkMock {
           body: JSON.stringify({
             items: this.gen.users.users(init?.size ?? 5),
             cursor: this.createCursorOption(init),
-          } as ContextListResult<IUser>),
+          } as ContextListResult<UserSchema>),
         }
         await mock.add(
           {
@@ -591,6 +591,56 @@ export class SdkMock {
         )
       },
     },
+
+    slugs: {
+      /**
+       * Mocks the `slugs.validate()` method.
+       * @param options Optional response customization.
+       */
+      validate: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+        const { mock } = this
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => JSON.stringify(this.gen.organization.organizationSlugValidateResponse()),
+          init
+        )
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.orgSlugValidate(),
+              methods: ['POST'],
+            },
+            respond,
+          },
+          options
+        )
+      },
+
+      /**
+       * Mocks the `slugs.generate()` method.
+       * @param options Optional response customization.
+       */
+      generate: async (init?: MockResult, options?: InterceptOptions): Promise<void> => {
+        const { mock } = this
+        const respond = this.createDefaultResponse(
+          200,
+          { 'content-type': 'application/json' },
+          () => JSON.stringify(this.gen.organization.organizationSlugGenerateResponse()),
+          init
+        )
+        await mock.add(
+          {
+            match: {
+              uri: RouteBuilder.orgSlugGenerate(),
+              methods: ['POST'],
+            },
+            respond,
+          },
+          options
+        )
+      },
+    },
   }
 
   /**
@@ -1004,13 +1054,13 @@ export class SdkMock {
       //   body: JSON.stringify({
       //     items: this.gen.files.files(init?.size ?? 5),
       //     cursor: this.createCursorOption(init),
-      //   } as ContextListResult<IFile>),
+      //   } as ContextListResult<FileSchema>),
       // }
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
         () => {
-          const obj: ContextListResult<IFile> = {
+          const obj: ContextListResult<FileSchema> = {
             items: this.gen.files.files(init?.size ?? 5),
             cursor: this.createCursorOption(init),
           }
@@ -1190,13 +1240,13 @@ export class SdkMock {
       //   headers: { 'content-type': 'application/json' },
       //   body: JSON.stringify({
       //     items: this.gen.files.files(init?.size ?? 5),
-      //   } as IBulkOperationResult<IFile>),
+      //   } as IBulkOperationResult<FileSchema>),
       // }
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
         () => {
-          const obj: IBulkOperationResult<IFile> = {
+          const obj: IBulkOperationResult<FileSchema> = {
             items: this.gen.files.files(init?.size ?? 5),
           }
           return JSON.stringify(obj)
@@ -1366,13 +1416,13 @@ export class SdkMock {
       //   body: JSON.stringify({
       //     items: this.gen.users.users(init?.size ?? 5),
       //     cursor: this.createCursorOption(init),
-      //   } as ContextListResult<IUser>),
+      //   } as ContextListResult<UserSchema>),
       // }
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
         () => {
-          const obj: ContextListResult<IUser> = {
+          const obj: ContextListResult<UserSchema> = {
             items: this.gen.users.users(init?.size ?? 5),
             cursor: this.createCursorOption(init),
           }
@@ -1447,13 +1497,13 @@ export class SdkMock {
       //   body: JSON.stringify({
       //     items: this.gen.files.files(init?.size ?? 5),
       //     cursor: this.createCursorOption(init),
-      //   } as ContextListResult<IFile>),
+      //   } as ContextListResult<FileSchema>),
       // }
       const respond = this.createDefaultResponse(
         200,
         { 'content-type': 'application/json' },
         () => {
-          const obj: ContextListResult<IFile> = {
+          const obj: ContextListResult<FileSchema> = {
             items: this.gen.files.files(init?.size ?? 5),
             cursor: this.createCursorOption(init),
           }

package/src/sdk/SharedSdk.ts

@@ -7,7 +7,7 @@ import {
   SdkOptions,
 } from './SdkBase.js'
 import { RouteBuilder } from './RouteBuilder.js'
-import { IFile } from '../models/store/File.js'
+import { FileSchema } from '../models/store/File.js'
 import { ContextListOptions, ContextListResult } from '../events/BaseEvents.js'
 import { Exception } from '../exceptions/exception.js'
 
@@ -23,7 +23,7 @@ export class SharedSdk extends SdkBase {
     organization: string,
     options?: ContextListOptions,
     request: SdkOptions = {}
-  ): Promise<ContextListResult<IFile>> {
+  ): Promise<ContextListResult<FileSchema>> {
     const { token } = request
     const url = this.sdk.getUrl(RouteBuilder.shared(organization))
     this.sdk.appendListOptions(url, options)
@@ -37,7 +37,7 @@ export class SharedSdk extends SdkBase {
     if (!result.body) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
     }
-    let data: ContextListResult<IFile>
+    let data: ContextListResult<FileSchema>
     try {
       data = JSON.parse(result.body)
     } catch {

package/src/sdk/StoreSdkNode.ts

@@ -9,9 +9,9 @@ export type { IMetaCreateOptions, IMediaCreateOptions, IFileCreateOptions, ListF
 export type {
   IJwtInfo,
   IJwtUser,
-  IRegistrationInfo,
-  IOrganizationRegistrationInfo,
-  IOrganizationAddUserInfo,
+  RegistrationInfoSchema,
+  OrganizationRegistrationInfoSchema,
+  OrganizationAddUserInfoSchema,
 } from './UsersSdk.js'
 export type { DataCatalogListOptions } from './DataCatalogSdk.js'
 

package/src/sdk/StoreSdkWeb.ts

@@ -9,9 +9,9 @@ export type { IMetaCreateOptions, IMediaCreateOptions, IFileCreateOptions, ListF
 export type {
   IJwtInfo,
   IJwtUser,
-  IRegistrationInfo,
-  IOrganizationRegistrationInfo,
-  IOrganizationAddUserInfo,
+  RegistrationInfoSchema,
+  OrganizationRegistrationInfoSchema,
+  OrganizationAddUserInfoSchema,
 } from './UsersSdk.js'
 export type { DataCatalogListOptions } from './DataCatalogSdk.js'
 

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/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',