@api-client/core 0.19.17 → 0.19.19

package/src/models/store/User.ts

@@ -1,7 +1,7 @@
-import type { IDeletion } from './Deletion.js'
+import type { DeletionSchema } from './Deletion.js'
 import type { UserOrganizationGrantType } from './Organization.js'
 
-export interface IEmail {
+export interface EmailSchema {
   /**
    * When available the email of the user.
    */
@@ -13,7 +13,12 @@ export interface IEmail {
   verified?: boolean
 }
 
-export interface IUserPicture {
+/**
+ * @deprecated Use {@link EmailSchema} instead.
+ */
+export type IEmail = EmailSchema
+
+export interface UserPictureSchema {
   /**
    * When available, the URL to the user's picture image.
    */
@@ -24,6 +29,11 @@ export interface IUserPicture {
   data?: string
 }
 
+/**
+ * @deprecated Use {@link UserPictureSchema} instead.
+ */
+export type IUserPicture = UserPictureSchema
+
 export const Kind = 'Core#User'
 
 export type UserStatus = 'active' | 'deleted' | 'suspended' | 'pending'
@@ -36,7 +46,7 @@ export type UserStatus = 'active' | 'deleted' | 'suspended' | 'pending'
  * Note, the store implementation may have additional fields that support external
  * identity providers. However, this is not exposed to the user through the API.
  */
-export interface IUser {
+export interface UserSchema {
   kind: typeof Kind
   /**
    * The data store key of the user.
@@ -53,7 +63,7 @@ export interface IUser {
   /**
    * The user picture to render.
    */
-  picture?: IUserPicture
+  picture?: UserPictureSchema
   /**
    * A general purpose tags field.
    */
@@ -109,5 +119,10 @@ export interface IUser {
    * The information about the delete information.
    * Always set when the `delete` is true.
    */
-  deletedInfo?: IDeletion
+  deletedInfo?: DeletionSchema
 }
+
+/**
+ * @deprecated Use {@link UserSchema} instead.
+ */
+export type IUser = UserSchema

package/src/models/store/UserIdentity.ts

@@ -9,7 +9,7 @@ type Provider = 'google'
  * This association allows the user to use different identity providers that map to the same user, as long as the
  * email stays consistent.
  */
-export interface IUserIdentity {
+export interface UserIdentitySchema {
   kind: typeof Kind
   /**
    * The database ID
@@ -39,7 +39,12 @@ export interface IUserIdentity {
   hostDomain?: string
 }
 
-export class UserIdentity implements IUserIdentity {
+/**
+ * @deprecated Use {@link UserIdentitySchema} instead.
+ */
+export type IUserIdentity = UserIdentitySchema
+
+export class UserIdentity implements UserIdentitySchema {
   kind: typeof Kind = Kind
   key = ''
   userId = ''
@@ -48,8 +53,8 @@ export class UserIdentity implements IUserIdentity {
   emailVerified = false
   hostDomain?: string
 
-  constructor(input?: string | IUserIdentity) {
-    let init: IUserIdentity
+  constructor(input?: string | UserIdentitySchema) {
+    let init: UserIdentitySchema
     if (typeof input === 'string') {
       init = JSON.parse(input)
     } else if (typeof input === 'object') {
@@ -67,7 +72,7 @@ export class UserIdentity implements IUserIdentity {
     this.new(init)
   }
 
-  new(init: IUserIdentity): void {
+  new(init: UserIdentitySchema): void {
     if (!UserIdentity.isUserIdentity(init)) {
       throw new Error(`Not a UserIdentity.`)
     }
@@ -86,15 +91,15 @@ export class UserIdentity implements IUserIdentity {
   }
 
   static isUserIdentity(input: unknown): boolean {
-    const typed = input as IUserIdentity
+    const typed = input as UserIdentitySchema
     if (!input || typed.kind !== Kind) {
       return false
     }
     return true
   }
 
-  toJSON(): IUserIdentity {
-    const result: IUserIdentity = {
+  toJSON(): UserIdentitySchema {
+    const result: UserIdentitySchema = {
       kind: Kind,
       key: this.key,
       provider: this.provider,

package/src/sdk/FilesSdk.ts

@@ -7,13 +7,13 @@ import {
   SdkOptions,
 } from './SdkBase.js'
 import { RouteBuilder } from './RouteBuilder.js'
-import type { IUser } from '../models/store/User.js'
-import type { FileBreadcrumb, IFile } from '../models/store/File.js'
+import type { UserSchema } from '../models/store/User.js'
+import type { FileBreadcrumb, FileSchema } from '../models/store/File.js'
 import { FolderKind, CertificateFileKind, ProjectKind, DomainFileKind } from '../models/kinds.js'
 import type { ContextListResult, IBulkOperationResult, ContextListOptions } from '../events/BaseEvents.js'
 import type { IAccessAddOperation, IAccessRemoveOperation, PermissionRole } from '../models/store/Permission.js'
 import { nanoid } from '../nanoid.js'
-import { Folder, type IFolder } from '../models/Folder.js'
+import { Folder, type FolderSchema } from '../models/Folder.js'
 import type { AccessPatchInfo, MediaPatchInfo, MediaPatchRevision, PatchInfo } from '../patch/types.js'
 import { Exception } from '../exceptions/exception.js'
 
@@ -57,7 +57,7 @@ export class FilesSdk extends SdkBase {
     organization: string,
     options: ContextListOptions = {},
     request: SdkOptions = {}
-  ): Promise<ContextListResult<IFile>> {
+  ): Promise<ContextListResult<FileSchema>> {
     const { token } = request
     const opts = { ...options }
     const url = this.sdk.getUrl(RouteBuilder.files(organization))
@@ -72,7 +72,7 @@ export class FilesSdk 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 {
@@ -94,12 +94,12 @@ export class FilesSdk extends SdkBase {
    * @returns The id of the created file meta.
    */
   async create(
-    meta: IFile,
+    meta: FileSchema,
     contents: unknown,
     organization: string,
     opts: IFileCreateOptions = {},
     request: SdkOptions = {}
-  ): Promise<IFile> {
+  ): Promise<FileSchema> {
     const result = await this.createMeta(meta, organization, opts, request)
     await this.createMedia(contents, organization, result.key, opts, request)
     return result
@@ -108,17 +108,17 @@ export class FilesSdk extends SdkBase {
   /**
    * Creates a file in the store.
    *
-   * @param file The definition of a file that extends the IFile interface.
+   * @param file The definition of a file that extends the FileSchema interface.
    * @param opts Optional options when creating a file
    * @param request Optional request options.
    * @returns The key of the creates file.
    */
   async createMeta(
-    file: IFile,
+    file: FileSchema,
     organization: string,
     opts: IMetaCreateOptions = {},
     request: SdkOptions = {}
-  ): Promise<IFile> {
+  ): Promise<FileSchema> {
     const { token } = request
     const url = this.sdk.getUrl(RouteBuilder.files(organization))
     if (opts.parent) {
@@ -142,7 +142,7 @@ export class FilesSdk extends SdkBase {
     if (!result.body) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
     }
-    let data: IFile
+    let data: FileSchema
     try {
       data = JSON.parse(result.body)
     } catch {
@@ -199,7 +199,7 @@ export class FilesSdk extends SdkBase {
     organization: string,
     opts: IMetaCreateOptions = {},
     request: SdkOptions = {}
-  ): Promise<IFolder> {
+  ): Promise<FolderSchema> {
     const file = Folder.fromName(name)
     const { token } = request
     const url = this.sdk.getUrl(RouteBuilder.files(organization))
@@ -224,7 +224,7 @@ export class FilesSdk extends SdkBase {
     if (!result.body) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
     }
-    let data: IFolder
+    let data: FolderSchema
     try {
       data = JSON.parse(result.body)
     } catch {
@@ -243,7 +243,7 @@ export class FilesSdk extends SdkBase {
    * @param fid The file key
    * @param request Optional request options.
    */
-  async read(oid: string, fid: string, request: SdkOptions = {}): Promise<IFile> {
+  async read(oid: string, fid: string, request: SdkOptions = {}): Promise<FileSchema> {
     const { token } = request
     const url = this.sdk.getUrl(RouteBuilder.file(oid, fid))
     const result = await this.sdk.http.get(url.toString(), { token })
@@ -256,7 +256,7 @@ export class FilesSdk extends SdkBase {
     if (!result.body) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
     }
-    let data: IFile
+    let data: FileSchema
     try {
       data = JSON.parse(result.body)
     } catch {
@@ -314,7 +314,11 @@ export class FilesSdk extends SdkBase {
    * in that place. It also inserts `undefined` in place of a file that doesn't exist.
    * @param request Optional request options.
    */
-  async readBulk(organization: string, keys: string[], request: SdkOptions = {}): Promise<IBulkOperationResult<IFile>> {
+  async readBulk(
+    organization: string,
+    keys: string[],
+    request: SdkOptions = {}
+  ): Promise<IBulkOperationResult<FileSchema>> {
     const { token } = request
     const url = this.sdk.getUrl(RouteBuilder.filesBatch(organization))
     const body = JSON.stringify({ ids: keys })
@@ -328,7 +332,7 @@ export class FilesSdk extends SdkBase {
     if (!result.body) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
     }
-    let data: IBulkOperationResult<IFile>
+    let data: IBulkOperationResult<FileSchema>
     try {
       data = JSON.parse(result.body)
     } catch {
@@ -347,7 +351,7 @@ export class FilesSdk extends SdkBase {
    * @param request Optional request options.
    * @returns The updated file object after applying the patch
    */
-  async patch(oid: string, fid: string, info: PatchInfo, request: SdkOptions = {}): Promise<IFile> {
+  async patch(oid: string, fid: string, info: PatchInfo, request: SdkOptions = {}): Promise<FileSchema> {
     const { token } = request
     const path = RouteBuilder.file(oid, fid)
     const url = this.sdk.getUrl(path)
@@ -362,7 +366,7 @@ export class FilesSdk extends SdkBase {
     if (!result.body) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
     }
-    let data: IFile
+    let data: FileSchema
     try {
       data = JSON.parse(result.body)
     } catch {
@@ -445,7 +449,7 @@ export class FilesSdk extends SdkBase {
    * @param info The patch operation on the file's ACL
    * @param request Optional request options.
    */
-  async patchUsers(oid: string, fid: string, info: AccessPatchInfo, request: SdkOptions = {}): Promise<IFile> {
+  async patchUsers(oid: string, fid: string, info: AccessPatchInfo, request: SdkOptions = {}): Promise<FileSchema> {
     const { token } = request
     const url = this.sdk.getUrl(RouteBuilder.filesAccess(oid, fid))
     const body = JSON.stringify(info)
@@ -459,7 +463,7 @@ export class FilesSdk extends SdkBase {
     if (!result.body) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
     }
-    let data: IFile
+    let data: FileSchema
     try {
       data = JSON.parse(result.body)
     } catch {
@@ -487,7 +491,7 @@ export class FilesSdk extends SdkBase {
     role: PermissionRole,
     expires?: number,
     request?: SdkOptions
-  ): Promise<IFile> {
+  ): Promise<FileSchema> {
     const op: IAccessAddOperation = {
       op: 'add',
       type: 'user',
@@ -511,7 +515,7 @@ export class FilesSdk extends SdkBase {
    * @param key The file key
    * @param otherUserKey The key of the user that gets access to the organization
    */
-  async removeUser(organization: string, key: string, otherUserKey: string, request?: SdkOptions): Promise<IFile> {
+  async removeUser(organization: string, key: string, otherUserKey: string, request?: SdkOptions): Promise<FileSchema> {
     const op: IAccessRemoveOperation = {
       op: 'remove',
       type: 'user',
@@ -530,7 +534,7 @@ export class FilesSdk extends SdkBase {
    * @param key The file key
    * @param request Optional request options.
    */
-  async listUsers(organization: string, key: string, request: SdkOptions = {}): Promise<ContextListResult<IUser>> {
+  async listUsers(organization: string, key: string, request: SdkOptions = {}): Promise<ContextListResult<UserSchema>> {
     const { token } = request
     const url = this.sdk.getUrl(RouteBuilder.fileUsers(organization, key))
     const result = await this.sdk.http.get(url.toString(), { token })
@@ -543,7 +547,7 @@ export class FilesSdk 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<IUser>
+    let data: ContextListResult<UserSchema>
     try {
       data = JSON.parse(result.body)
     } catch {

package/src/sdk/OrganizationsSdk.ts

@@ -8,17 +8,21 @@ import {
 } from './SdkBase.js'
 import { RouteBuilder } from './RouteBuilder.js'
 import type { ContextListOptions, ContextListResult } from '../events/BaseEvents.js'
-import type { IOrganization, UserOrganizationGrantType } from '../models/store/Organization.js'
+import type {
+  OrganizationSchema,
+  UserOrganizationGrantType,
+  OrganizationSlugValidateResponse,
+} from '../models/store/Organization.js'
 import type { InvitationSchema } from '../models/store/Invitation.js'
 import type { PatchInfo } from '../patch/types.js'
-import type { IUser } from '../models/store/User.js'
+import type { UserSchema } from '../models/store/User.js'
 import { Exception } from '../exceptions/exception.js'
 
 export class OrganizationsSdk extends SdkBase {
   /**
    * Lists all user organizations.
    */
-  async list(request: SdkOptions = {}): Promise<ContextListResult<IOrganization>> {
+  async list(request: SdkOptions = {}): Promise<ContextListResult<OrganizationSchema>> {
     const { token } = request
     const url = this.sdk.getUrl(RouteBuilder.organizations())
     const result = await this.sdk.http.get(url.toString(), { token })
@@ -31,7 +35,7 @@ export class OrganizationsSdk 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<IOrganization>
+    let data: ContextListResult<OrganizationSchema>
     try {
       data = JSON.parse(result.body)
     } catch {
@@ -49,7 +53,7 @@ export class OrganizationsSdk extends SdkBase {
    * @param request The request options.
    * @returns A promise that resolves to the created organization.
    */
-  async create(orgName: string, request: SdkOptions = {}): Promise<IOrganization> {
+  async create(orgName: string, request: SdkOptions = {}): Promise<OrganizationSchema> {
     const { token } = request
     const url = this.sdk.getUrl(RouteBuilder.organizations())
     const body = {
@@ -71,7 +75,7 @@ export class OrganizationsSdk extends SdkBase {
     if (!result.body) {
       throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
     }
-    let data: IOrganization
+    let data: OrganizationSchema
     try {
       data = JSON.parse(result.body)
     } catch {
@@ -345,7 +349,7 @@ export class OrganizationsSdk extends SdkBase {
       oid: string,
       options?: ContextListOptions,
       request: SdkOptions = {}
-    ): Promise<ContextListResult<IUser>> => {
+    ): Promise<ContextListResult<UserSchema>> => {
       const { token } = request
       const url = this.sdk.getUrl(RouteBuilder.organizationUsers(oid))
       this.sdk.appendListOptions(url, options)
@@ -359,7 +363,7 @@ export class OrganizationsSdk 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<IUser>
+      let data: ContextListResult<UserSchema>
       try {
         data = JSON.parse(result.body)
       } catch {
@@ -379,7 +383,7 @@ export class OrganizationsSdk extends SdkBase {
      * @param request Optional request options.
      * @returns The user object
      */
-    read: async (oid: string, key: string, request: SdkOptions = {}): Promise<IUser> => {
+    read: async (oid: string, key: string, request: SdkOptions = {}): Promise<UserSchema> => {
       const { token } = request
       const url = this.sdk.getUrl(RouteBuilder.organizationUser(oid, key))
       const result = await this.sdk.http.get(url.toString(), { token })
@@ -392,7 +396,7 @@ export class OrganizationsSdk 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 {
@@ -410,7 +414,11 @@ export class OrganizationsSdk extends SdkBase {
      * @param request Optional request options.
      * @returns The created user object.
      */
-    readBatch: async (oid: string, keys: string[], request: SdkOptions = {}): Promise<ContextListResult<IUser>> => {
+    readBatch: async (
+      oid: string,
+      keys: string[],
+      request: SdkOptions = {}
+    ): Promise<ContextListResult<UserSchema>> => {
       const { token } = request
       const url = this.sdk.getUrl(RouteBuilder.organizationUserBatch(oid))
       const body = {
@@ -429,7 +437,7 @@ export class OrganizationsSdk 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<IUser>
+      let data: ContextListResult<UserSchema>
       try {
         data = JSON.parse(result.body)
       } catch {
@@ -447,7 +455,7 @@ export class OrganizationsSdk extends SdkBase {
      * @param oid The key of the organization parent organization.
      * @param key The user key.
      */
-    activate: async (oid: string, key: string, request: SdkOptions = {}): Promise<IUser> => {
+    activate: async (oid: string, key: string, request: SdkOptions = {}): Promise<UserSchema> => {
       const { token } = request
       const url = this.sdk.getUrl(RouteBuilder.organizationUserActivate(oid, key))
       const result = await this.sdk.http.post(url.toString(), { token })
@@ -460,7 +468,7 @@ export class OrganizationsSdk 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 {
@@ -475,7 +483,7 @@ export class OrganizationsSdk extends SdkBase {
      * @param oid The key of the organization parent organization.
      * @param key The user key.
      */
-    deactivate: async (oid: string, key: string, request: SdkOptions = {}): Promise<IUser> => {
+    deactivate: async (oid: string, key: string, request: SdkOptions = {}): Promise<UserSchema> => {
       const { token } = request
       const url = this.sdk.getUrl(RouteBuilder.organizationUserDeactivate(oid, key))
       const result = await this.sdk.http.post(url.toString(), { token })
@@ -488,7 +496,7 @@ export class OrganizationsSdk 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 {
@@ -516,4 +524,80 @@ export class OrganizationsSdk extends SdkBase {
       }
     },
   }
+
+  slugs = {
+    /**
+     * Generates a slug for the organization.
+     * @param name The name of the organization.
+     * @param request Optional request options.
+     * @returns A promise that resolves to the generated slug.
+     */
+    generate: async (name: string, request: SdkOptions = {}): Promise<string> => {
+      const { token } = request
+      const url = this.sdk.getUrl(RouteBuilder.orgSlugGenerate()).toString()
+      const body = {
+        name,
+      }
+      const result = await this.sdk.http.post(url, {
+        body: JSON.stringify(body),
+        token,
+      })
+      this.inspectCommonStatusCodes(result)
+      const E_PREFIX = 'Unable to generate the slug. '
+      if (result.status !== 200) {
+        this.logInvalidResponse(result)
+        throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
+      }
+      if (!result.body) {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
+      }
+      let data: { slug: string }
+      try {
+        data = JSON.parse(result.body)
+      } catch {
+        throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
+      }
+      if (!data.slug) {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
+      }
+      return data.slug
+    },
+
+    /**
+     * Validates a slug for the organization.
+     * @param slug The slug to validate.
+     * @param request Optional request options.
+     * @returns A promise that resolves to the validation result.
+     */
+    validate: async (slug: string, request: SdkOptions = {}): Promise<OrganizationSlugValidateResponse> => {
+      const { token } = request
+      const url = this.sdk.getUrl(RouteBuilder.orgSlugValidate()).toString()
+      const body = {
+        slug,
+      }
+      const result = await this.sdk.http.post(url, {
+        body: JSON.stringify(body),
+        token,
+      })
+      this.inspectCommonStatusCodes(result)
+      const E_PREFIX = 'Unable to validate the slug. '
+      if (result.status !== 200) {
+        this.logInvalidResponse(result)
+        throw this.createApiError(`${E_PREFIX}${E_RESPONSE_STATUS}${result.status}`, result.body)
+      }
+      if (!result.body) {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_NO_VALUE}`, { code: 'E_RESPONSE_NO_VALUE', status: result.status })
+      }
+      let data: OrganizationSlugValidateResponse
+      try {
+        data = JSON.parse(result.body)
+      } catch {
+        throw new Exception(`${E_PREFIX}${E_INVALID_JSON}`, { code: 'E_INVALID_JSON', status: result.status })
+      }
+      if (typeof data.valid !== 'boolean') {
+        throw new Exception(`${E_PREFIX}${E_RESPONSE_UNKNOWN}`, { code: 'E_RESPONSE_UNKNOWN', status: result.status })
+      }
+      return data
+    },
+  }
 }

package/src/sdk/RouteBuilder.ts

@@ -326,4 +326,12 @@ export class RouteBuilder {
   static aiMessage(oid: string, sid: string, mid: string): string {
     return `${RouteBuilder.aiMessages(oid, sid)}/${mid}`
   }
+
+  static orgSlugGenerate(): string {
+    return `/v1/orgs/slugs/generate`
+  }
+
+  static orgSlugValidate(): string {
+    return `/v1/orgs/slugs/validate`
+  }
 }