@alienplatform/platform-api 1.0.68 → 1.3.4

package/src/lib/security.ts

@@ -2,16 +2,16 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import type * as models from "../models/index.js"
-import { env } from "./env.js"
+import * as models from "../models/index.js";
+import { env } from "./env.js";
 
 type OAuth2PasswordFlow = {
-  username: string
-  password: string
-  clientID?: string | undefined
-  clientSecret?: string | undefined
-  tokenURL: string
-}
+  username: string;
+  password: string;
+  clientID?: string | undefined;
+  clientSecret?: string | undefined;
+  tokenURL: string;
+};
 
 export enum SecurityErrorCode {
   Incomplete = "incomplete",
@@ -23,85 +23,91 @@ export class SecurityError extends Error {
     public code: SecurityErrorCode,
     message: string,
   ) {
-    super(message)
-    this.name = "SecurityError"
+    super(message);
+    this.name = "SecurityError";
   }
 
   static incomplete(): SecurityError {
     return new SecurityError(
       SecurityErrorCode.Incomplete,
       "Security requirements not met in order to perform the operation",
-    )
+    );
   }
   static unrecognizedType(type: string): SecurityError {
     return new SecurityError(
       SecurityErrorCode.UnrecognisedSecurityType,
       `Unrecognised security type: ${type}`,
-    )
+    );
   }
 }
 
 export type SecurityState = {
-  basic: { username?: string | undefined; password?: string | undefined }
-  headers: Record<string, string>
-  queryParams: Record<string, string>
-  cookies: Record<string, string>
-  oauth2: ({ type: "password" } & OAuth2PasswordFlow) | { type: "none" }
-}
+  basic: { username?: string | undefined; password?: string | undefined };
+  headers: Record<string, string>;
+  queryParams: Record<string, string>;
+  cookies: Record<string, string>;
+  oauth2: ({ type: "password" } & OAuth2PasswordFlow) | { type: "none" };
+};
 
 type SecurityInputBasic = {
-  type: "http:basic"
-  value: { username?: string | undefined; password?: string | undefined } | null | undefined
-}
+  type: "http:basic";
+  value:
+    | { username?: string | undefined; password?: string | undefined }
+    | null
+    | undefined;
+};
 
 type SecurityInputBearer = {
-  type: "http:bearer"
-  value: string | null | undefined
-  fieldName: string
-}
+  type: "http:bearer";
+  value: string | null | undefined;
+  fieldName: string;
+};
 
 type SecurityInputAPIKey = {
-  type: "apiKey:header" | "apiKey:query" | "apiKey:cookie"
-  value: string | null | undefined
-  fieldName: string
-}
+  type: "apiKey:header" | "apiKey:query" | "apiKey:cookie";
+  value: string | null | undefined;
+  fieldName: string;
+};
 
 type SecurityInputOIDC = {
-  type: "openIdConnect"
-  value: string | null | undefined
-  fieldName: string
-}
+  type: "openIdConnect";
+  value: string | null | undefined;
+  fieldName: string;
+};
 
 type SecurityInputOAuth2 = {
-  type: "oauth2"
-  value: string | null | undefined
-  fieldName: string
-}
+  type: "oauth2";
+  value: string | null | undefined;
+  fieldName: string;
+};
 
 type SecurityInputOAuth2ClientCredentials = {
-  type: "oauth2:client_credentials"
+  type: "oauth2:client_credentials";
   value:
     | {
-        clientID?: string | undefined
-        clientSecret?: string | undefined
-      }
+      clientID?: string | undefined;
+      clientSecret?: string | undefined;
+    }
     | null
     | string
-    | undefined
-  fieldName?: string
-}
+    | undefined;
+  fieldName?: string;
+};
 
 type SecurityInputOAuth2PasswordCredentials = {
-  type: "oauth2:password"
-  value: string | null | undefined
-  fieldName?: string
-}
+  type: "oauth2:password";
+  value:
+    | string
+    | null
+    | undefined;
+  fieldName?: string;
+};
 
 type SecurityInputCustom = {
-  type: "http:custom"
-  value: any | null | undefined
-  fieldName?: string
-}
+  type: "http:custom";
+  value: any | null | undefined;
+  fieldName?: string;
+};
 
 export type SecurityInput =
   | SecurityInputBasic
@@ -111,94 +117,104 @@ export type SecurityInput =
   | SecurityInputOAuth2ClientCredentials
   | SecurityInputOAuth2PasswordCredentials
   | SecurityInputOIDC
-  | SecurityInputCustom
+  | SecurityInputCustom;
 
-export function resolveSecurity(...options: SecurityInput[][]): SecurityState | null {
+export function resolveSecurity(
+  ...options: SecurityInput[][]
+): SecurityState | null {
   const state: SecurityState = {
     basic: {},
     headers: {},
     queryParams: {},
     cookies: {},
     oauth2: { type: "none" },
-  }
+  };
 
-  const option = options.find(opts => {
-    return opts.every(o => {
+  const option = options.find((opts) => {
+    return opts.every((o) => {
       if (o.value == null) {
-        return false
+        return false;
       } else if (o.type === "http:basic") {
-        return o.value.username != null || o.value.password != null
+        return o.value.username != null || o.value.password != null;
       } else if (o.type === "http:custom") {
-        return null
+        return null;
       } else if (o.type === "oauth2:password") {
-        return typeof o.value === "string" && !!o.value
+        return (
+          typeof o.value === "string" && !!o.value
+        );
       } else if (o.type === "oauth2:client_credentials") {
         if (typeof o.value == "string") {
-          return !!o.value
+          return !!o.value;
         }
-        return o.value.clientID != null || o.value.clientSecret != null
+        return o.value.clientID != null || o.value.clientSecret != null;
       } else if (typeof o.value === "string") {
-        return !!o.value
+        return !!o.value;
       } else {
-        throw new Error(`Unrecognized security type: ${o.type} (value type: ${typeof o.value})`)
+        throw new Error(
+          `Unrecognized security type: ${o.type} (value type: ${typeof o
+            .value})`,
+        );
       }
-    })
-  })
+    });
+  });
   if (option == null) {
-    return null
+    return null;
   }
 
-  option.forEach(spec => {
+  option.forEach((spec) => {
     if (spec.value == null) {
-      return
+      return;
     }
 
-    const { type } = spec
+    const { type } = spec;
 
     switch (type) {
       case "apiKey:header":
-        state.headers[spec.fieldName] = spec.value
-        break
+        state.headers[spec.fieldName] = spec.value;
+        break;
       case "apiKey:query":
-        state.queryParams[spec.fieldName] = spec.value
-        break
+        state.queryParams[spec.fieldName] = spec.value;
+        break;
       case "apiKey:cookie":
-        state.cookies[spec.fieldName] = spec.value
-        break
+        state.cookies[spec.fieldName] = spec.value;
+        break;
       case "http:basic":
-        applyBasic(state, spec)
-        break
+        applyBasic(state, spec);
+        break;
       case "http:custom":
-        break
+        break;
       case "http:bearer":
-        applyBearer(state, spec)
-        break
+        applyBearer(state, spec);
+        break;
       case "oauth2":
-        applyBearer(state, spec)
-        break
+        applyBearer(state, spec);
+        break;
       case "oauth2:password":
-        applyBearer(state, spec)
-        break
+        applyBearer(state, spec);
+        break;
       case "oauth2:client_credentials":
-        break
+        break;
       case "openIdConnect":
-        applyBearer(state, spec)
-        break
+        applyBearer(state, spec);
+        break;
       default:
-        spec satisfies never
-        throw SecurityError.unrecognizedType(type)
+        spec satisfies never;
+        throw SecurityError.unrecognizedType(type);
     }
-  })
+  });
 
-  return state
+  return state;
 }
 
-function applyBasic(state: SecurityState, spec: SecurityInputBasic) {
+function applyBasic(
+  state: SecurityState,
+  spec: SecurityInputBasic,
+) {
   if (spec.value == null) {
-    return
+    return;
   }
 
-  state.basic = spec.value
+  state.basic = spec.value;
 }
 
 function applyBearer(
@@ -210,37 +226,39 @@ function applyBearer(
     | SecurityInputOAuth2PasswordCredentials,
 ) {
   if (typeof spec.value !== "string" || !spec.value) {
-    return
+    return;
   }
 
-  let value = spec.value
+  let value = spec.value;
   if (value.slice(0, 7).toLowerCase() !== "bearer ") {
-    value = `Bearer ${value}`
+    value = `Bearer ${value}`;
   }
 
   if (spec.fieldName !== undefined) {
-    state.headers[spec.fieldName] = value
+    state.headers[spec.fieldName] = value;
   }
 }
 
 export function resolveGlobalSecurity(
   security: Partial<models.Security> | null | undefined,
 ): SecurityState | null {
-  return resolveSecurity([
-    {
-      fieldName: "Authorization",
-      type: "http:bearer",
-      value: security?.apiKey ?? env().ALIEN_API_KEY,
-    },
-  ])
+  return resolveSecurity(
+    [
+      {
+        fieldName: "Authorization",
+        type: "http:bearer",
+        value: security?.apiKey ?? env().ALIEN_API_KEY,
+      },
+    ],
+  );
 }
 
-export async function extractSecurity<T extends string | Record<string, unknown>>(
-  sec: T | (() => Promise<T>) | undefined,
-): Promise<T | undefined> {
+export async function extractSecurity<
+  T extends string | Record<string, unknown>,
+>(sec: T | (() => Promise<T>) | undefined): Promise<T | undefined> {
   if (sec == null) {
-    return
+    return;
   }
 
-  return typeof sec === "function" ? sec() : sec
+  return typeof sec === "function" ? sec() : sec;
 }

package/src/lib/url.ts

@@ -2,28 +2,32 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-const hasOwn = Object.prototype.hasOwnProperty
+const hasOwn = Object.prototype.hasOwnProperty;
 
-export type Params = Partial<Record<string, string | number>>
+export type Params = Partial<Record<string, string | number>>;
 
 export function pathToFunc(
   pathPattern: string,
   options?: { charEncoding?: "percent" | "none" },
 ): (params?: Params) => string {
-  const paramRE = /\{([a-zA-Z0-9_][a-zA-Z0-9_-]*?)\}/g
+  const paramRE = /\{([a-zA-Z0-9_][a-zA-Z0-9_-]*?)\}/g;
 
   return function buildURLPath(params: Record<string, unknown> = {}): string {
-    return pathPattern.replace(paramRE, (_, placeholder) => {
+    return pathPattern.replace(paramRE, function (_, placeholder) {
       if (!hasOwn.call(params, placeholder)) {
-        throw new Error(`Parameter '${placeholder}' is required`)
+        throw new Error(`Parameter '${placeholder}' is required`);
       }
 
-      const value = params[placeholder]
+      const value = params[placeholder];
       if (typeof value !== "string" && typeof value !== "number") {
-        throw new Error(`Parameter '${placeholder}' must be a string or number`)
+        throw new Error(
+          `Parameter '${placeholder}' must be a string or number`,
+        );
       }
 
-      return options?.charEncoding === "percent" ? encodeURIComponent(`${value}`) : `${value}`
-    })
-  }
+      return options?.charEncoding === "percent"
+        ? encodeURIComponent(`${value}`)
+        : `${value}`;
+    });
+  };
 }

package/src/models/apierror.ts

@@ -2,10 +2,10 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod/v4"
-import { safeParse } from "../lib/schemas.js"
-import type { Result as SafeParseResult } from "../types/fp.js"
-import type { SDKValidationError } from "./errors/sdkvalidationerror.js"
+import * as z from "zod/v4";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
 /**
  * Error that occurred during context building
@@ -20,7 +20,7 @@ export type APIError = {
    * by clients to programmatically handle different error types.
    * Examples: "NOT_FOUND", "VALIDATION_ERROR", "TIMEOUT"
    */
-  code: string
+  code: string;
   /**
    * Human-readable error message.
    *
@@ -29,8 +29,17 @@ export type APIError = {
    * This message should be clear and actionable for developers or end-users,
    * providing context about what went wrong and potentially how to fix it.
    */
-  message: string
-  source?: any | null | undefined
+  message: string;
+  /**
+   * The underlying error that caused this error, creating an error chain.
+   *
+   * @remarks
+   *
+   * This allows for proper error propagation and debugging by maintaining
+   * the full context of how an error occurred through multiple layers
+   * of an application.
+   */
+  source?: any | null | undefined;
   /**
    * Indicates whether the operation that caused the error should be retried.
    *
@@ -40,8 +49,17 @@ export type APIError = {
    * if attempted again. When `false`, retrying the same operation is
    * unlikely to succeed without changes.
    */
-  retryable: boolean
-  context?: any | null | undefined
+  retryable: boolean;
+  /**
+   * Additional diagnostic information about the error context.
+   *
+   * @remarks
+   *
+   * This optional field can contain structured data providing more details
+   * about the error, such as validation errors, request parameters that
+   * caused the issue, or other relevant context information.
+   */
+  context?: any | null | undefined;
   /**
    * HTTP status code for this error.
    *
@@ -50,7 +68,7 @@ export type APIError = {
    * Used when converting the error to an HTTP response. If None, falls back to
    * the error type's default status code or 500.
    */
-  httpStatusCode?: number | null | undefined
+  httpStatusCode?: number | null | undefined;
   /**
    * Indicates if this is an internal error that should not be exposed to users.
    *
@@ -60,8 +78,8 @@ export type APIError = {
    * details that should not be shown to end-users. Such errors should be
    * logged for debugging but replaced with generic error messages in responses.
    */
-  internal: boolean
-}
+  internal: boolean;
+};
 
 /** @internal */
 export const APIError$inboundSchema: z.ZodType<APIError, unknown> = z.object({
@@ -72,14 +90,14 @@ export const APIError$inboundSchema: z.ZodType<APIError, unknown> = z.object({
   context: z.nullable(z.any()).optional(),
   httpStatusCode: z.nullable(z.int()).optional(),
   internal: z.boolean(),
-})
+});
 
 export function apiErrorFromJSON(
   jsonString: string,
 ): SafeParseResult<APIError, SDKValidationError> {
   return safeParse(
     jsonString,
-    x => APIError$inboundSchema.parse(JSON.parse(x)),
+    (x) => APIError$inboundSchema.parse(JSON.parse(x)),
     `Failed to parse 'APIError' from JSON`,
-  )
+  );
 }

package/src/models/apikey.ts

@@ -2,11 +2,11 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod/v4"
-import { safeParse } from "../lib/schemas.js"
-import type { ClosedEnum } from "../types/enums.js"
-import type { Result as SafeParseResult } from "../types/fp.js"
-import type { SDKValidationError } from "./errors/sdkvalidationerror.js"
+import * as z from "zod/v4";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
 export const APIKeyType = {
   Workspace: "workspace",
@@ -14,17 +14,17 @@ export const APIKeyType = {
   Deployment: "deployment",
   DeploymentGroup: "deployment-group",
   Manager: "manager",
-} as const
-export type APIKeyType = ClosedEnum<typeof APIKeyType>
+} as const;
+export type APIKeyType = ClosedEnum<typeof APIKeyType>;
 
 /**
  * User information associated with the API key
  */
 export type CreatedByUser = {
-  id: string
-  email: string
-  image: string | null
-}
+  id: string;
+  email: string;
+  image: string | null;
+};
 
 /**
  * API key information
@@ -33,45 +33,48 @@ export type APIKey = {
   /**
    * Unique identifier for the api key.
    */
-  id: string
-  description: string | null
-  keyPrefix: string
-  type: APIKeyType
-  role: string
-  workspaceId: string
-  projectId: string | null
-  deploymentId: string | null
-  deploymentGroupId: string | null
-  managerId: string | null
-  enabled: boolean
-  createdAt: Date
-  expiresAt: Date | null
-  lastUsedAt: Date | null
-  revokedAt: Date | null
+  id: string;
+  description: string | null;
+  keyPrefix: string;
+  type: APIKeyType;
+  role: string;
+  workspaceId: string;
+  projectId: string | null;
+  deploymentId: string | null;
+  deploymentGroupId: string | null;
+  managerId: string | null;
+  enabled: boolean;
+  createdAt: Date;
+  expiresAt: Date | null;
+  lastUsedAt: Date | null;
+  revokedAt: Date | null;
   /**
    * User information associated with the API key
    */
-  createdByUser: CreatedByUser | null
-}
+  createdByUser: CreatedByUser | null;
+};
 
 /** @internal */
-export const APIKeyType$inboundSchema: z.ZodEnum<typeof APIKeyType> = z.enum(APIKeyType)
+export const APIKeyType$inboundSchema: z.ZodEnum<typeof APIKeyType> = z.enum(
+  APIKeyType,
+);
 
 /** @internal */
-export const CreatedByUser$inboundSchema: z.ZodType<CreatedByUser, unknown> = z.object({
-  id: z.string(),
-  email: z.string(),
-  image: z.nullable(z.string()),
-})
+export const CreatedByUser$inboundSchema: z.ZodType<CreatedByUser, unknown> = z
+  .object({
+    id: z.string(),
+    email: z.string(),
+    image: z.nullable(z.string()),
+  });
 
 export function createdByUserFromJSON(
   jsonString: string,
 ): SafeParseResult<CreatedByUser, SDKValidationError> {
   return safeParse(
     jsonString,
-    x => CreatedByUser$inboundSchema.parse(JSON.parse(x)),
+    (x) => CreatedByUser$inboundSchema.parse(JSON.parse(x)),
     `Failed to parse 'CreatedByUser' from JSON`,
-  )
+  );
 }
 
 /** @internal */
@@ -88,16 +91,24 @@ export const APIKey$inboundSchema: z.ZodType<APIKey, unknown> = z.object({
   managerId: z.nullable(z.string()),
   enabled: z.boolean(),
   createdAt: z.iso.datetime({ offset: true }).transform(v => new Date(v)),
-  expiresAt: z.nullable(z.iso.datetime({ offset: true }).transform(v => new Date(v))),
-  lastUsedAt: z.nullable(z.iso.datetime({ offset: true }).transform(v => new Date(v))),
-  revokedAt: z.nullable(z.iso.datetime({ offset: true }).transform(v => new Date(v))),
+  expiresAt: z.nullable(
+    z.iso.datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  lastUsedAt: z.nullable(
+    z.iso.datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  revokedAt: z.nullable(
+    z.iso.datetime({ offset: true }).transform(v => new Date(v)),
+  ),
   createdByUser: z.nullable(z.lazy(() => CreatedByUser$inboundSchema)),
-})
+});
 
-export function apiKeyFromJSON(jsonString: string): SafeParseResult<APIKey, SDKValidationError> {
+export function apiKeyFromJSON(
+  jsonString: string,
+): SafeParseResult<APIKey, SDKValidationError> {
   return safeParse(
     jsonString,
-    x => APIKey$inboundSchema.parse(JSON.parse(x)),
+    (x) => APIKey$inboundSchema.parse(JSON.parse(x)),
     `Failed to parse 'APIKey' from JSON`,
-  )
+  );
 }