@api-client/core 0.19.18 → 0.19.19

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.19.18",
+  "version": "0.19.19",
   "license": "UNLICENSED",
   "exports": {
     "./browser.js": {

package/src/mocking/lib/Organization.ts

@@ -1,9 +1,30 @@
 import { faker } from '@faker-js/faker'
 import { OrganizationKind } from '../../models/kinds.js'
 import { nanoid } from '../../nanoid.js'
-import type { OrganizationSchema } from '../../models/store/Organization.js'
+import type { OrganizationSchema, OrganizationSlugValidateResponse } from '../../models/store/Organization.js'
 
 export class Organization {
+  organizationSlugGenerateResponse(name?: string): { slug: string } {
+    const finalName = name ?? faker.company.name()
+    let baseSlug = faker.helpers.slugify(finalName)
+    // Truncate to ensure there's room for a suffix if needed
+    if (baseSlug.length > 55) {
+      baseSlug = baseSlug.substring(0, 55)
+    }
+    const suffix = nanoid(6).toLowerCase()
+    return { slug: `${baseSlug}-${suffix}` }
+  }
+
+  organizationSlugValidateResponse(
+    init: Partial<OrganizationSlugValidateResponse> = {}
+  ): OrganizationSlugValidateResponse {
+    const { valid = true, reason } = init
+    return {
+      valid,
+      reason,
+    }
+  }
+
   /**
    * Generates a random organization object.
    * @param init Optional values to be present in the object.

package/src/models/store/Organization.ts

@@ -4,6 +4,20 @@ import { OrganizationKind } from '../kinds.js'
 
 export type UserOrganizationGrantType = 'owner' | 'manager' | 'editor' | 'viewer'
 
+/**
+ * The response of the organization slug validation.
+ */
+export interface OrganizationSlugValidateResponse {
+  /**
+   * Whether the slug is valid.
+   */
+  valid: boolean
+  /**
+   * The reason why the slug is invalid.
+   */
+  reason?: string
+}
+
 /**
  * In the system the user identity represents registration information associated with a specific identity provider.
  * This association allows the user to use different identity providers that map to the same user, as long as the

package/src/sdk/OrganizationsSdk.ts

@@ -8,7 +8,11 @@ import {
 } from './SdkBase.js'
 import { RouteBuilder } from './RouteBuilder.js'
 import type { ContextListOptions, ContextListResult } from '../events/BaseEvents.js'
-import type { OrganizationSchema, 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 { UserSchema } from '../models/store/User.js'
@@ -520,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`
+  }
 }

package/src/sdk/SdkMock.ts

@@ -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
+        )
+      },
+    },
   }
 
   /**