npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@alienplatform/platform-api

v3.3.50

Published

Developer-friendly & type-safe Typescript SDK specifically catered to leverage _openapi_ API.

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

alonalienalonalien

Keywords

Readme

openapi

Developer-friendly & type-safe Typescript SDK specifically catered to leverage openapi API.

[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Table of Contents

SDK Installation

[!TIP] To finish publishing your SDK to npm and others you must run your first generation action.

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add <UNSET>
# Install optional peer dependencies if you plan to use React hooks
npm add @tanstack/react-query react react-dom

PNPM

pnpm add <UNSET>
# Install optional peer dependencies if you plan to use React hooks
pnpm add @tanstack/react-query react react-dom

Bun

bun add <UNSET>
# Install optional peer dependencies if you plan to use React hooks
bun add @tanstack/react-query react react-dom

Yarn

yarn add <UNSET>
# Install optional peer dependencies if you plan to use React hooks
yarn add @tanstack/react-query react react-dom

[!NOTE] This package is published as an ES Module (ESM) only. For applications using CommonJS, use await import() to import and use this package.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Alien } from "@alienplatform/platform-api";

const alien = new Alien({
  apiKey: process.env["ALIEN_API_KEY"] ?? "",
});

async function run() {
  const result = await alien.getWorkspaceInvitationPreview({
    token: "<value>",
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | -------- | ---- | ----------- | -------------------- | | apiKey | http | HTTP Bearer | ALIEN_API_KEY |

To authenticate with the API the apiKey parameter must be set when initializing the SDK client instance. For example:

import { Alien } from "@alienplatform/platform-api";

const alien = new Alien({
  apiKey: process.env["ALIEN_API_KEY"] ?? "",
});

async function run() {
  const result = await alien.getWorkspaceInvitationPreview({
    token: "<value>",
  });

  console.log(result);
}

run();

Available Resources and Operations

Alien SDK

AgentSessions

  • list - List ai-agent monitor sessions for this workspace, or for one project. Newest first, capped at 50.
  • get - Retrieve one ai-agent monitor session by id.
  • events - Incrementally read a session's event log (steps, tool calls, report deltas, approvals, status transitions). Pass the previous response's latestSeq as after to fetch only new events.
  • stop - Stop (cancel) a running or queued ai-agent monitor session. Proxies to the ai-agent service, minting a fresh CLI session for the caller so the ai-agent's own auth applies. Idempotent — stopping an already-terminal session is a 200 no-op.

ApiKeys

  • list - Retrieve all API keys for the current workspace.
  • create - Create a new API key.
  • get - Retrieve a specific API key.
  • update - Update an API key (enable/disable, change description).
  • revoke - Revoke (soft delete) an API key.
  • deleteMultiple - Permanently delete multiple API keys.

Auth

  • whoami - Get the current authenticated principal (user or service account). Works with both session cookies and API keys.

Billing

  • getEntitlements - Get the workspace billing entitlements used for product feature gates. Autumn is the source of truth; the response is served through the workspace billing read model with stale-cache fallback.
  • sync - Refresh the workspace billing entitlements from Autumn now, for example right after checkout, instead of waiting for Autumn's billing webhook. Workspace admins only. Calls within a few seconds share one refresh.

CloudRegions

  • get - Get cloud regions supported by this Alien environment.

Commands

  • bootstrap - Resolve a deployment's current manager and mint a five-minute command capability. Sender tokens can dispatch and observe commands only for this deployment. Receiver tokens can lease and complete commands only for the resolved Container or Daemon target.
  • list - Retrieve commands. Use for dashboard analytics and command history.
  • create - Create command metadata. Called by manager when processing commands. Returns project info for routing decisions.
  • listNames - List distinct command names. Use for filter dropdowns in the dashboard.
  • listDeployments - List distinct deployments that have commands, including deployment group info. Use for filter dropdowns in the dashboard.
  • resolveTarget - Resolve which resource a command for this deployment would be addressed to, and how it would be delivered. Fails when the deployment has no command-capable resources, or more than one and no explicit target was named.
  • update - Update command state. Called by manager when command is dispatched or completes.
  • get - Retrieve a command by ID.
  • dispatch - Atomically mark a command DISPATCHED unless it is already terminal. Returns whether the transition was applied.
  • complete - Atomically transition a command to a terminal state (SUCCEEDED, FAILED, or EXPIRED) unless it is already terminal. Returns whether the transition was applied.
  • incrementAttempt - Atomically increment the command's attempt counter and return the new value.

ContainerRegistry

DebugSessions

  • list - Retrieve debug sessions for dashboard audit. Filters: project, deployment, state, mode.
  • create - Create a debug-session audit row. Called by the manager when a pull or push debug tunnel is opened. Workspace + project derived from deployment.
  • update - Update debug-session state. Called by manager on tunnel attach, close, or deadline expiry.
  • get - Retrieve a debug session by ID.

Deployment

  • getInfo - Get deployment information for the deployment portal. Accepts both deployment-scoped and deployment-group-scoped API keys. Returns project information, package status/outputs, and either deployment or deployment group details depending on the token type. Poll this endpoint to check if packages are ready.
  • planCompute - Plan deployment compute for the active release before stack preparation. The response contains recommended machine and scale choices for cloud compute pools.
  • prepareStack - Prepare the active release stack for a deployment portal setup session. The response contains the generated stack shape plus setup compatibility metadata.

DeploymentGroups

Deployments

  • move - Reassign a deployment to another group within its project
  • list - Retrieve all deployments.
  • create - Create a new deployment. Deployment group tokens automatically use their group. Workspace/project tokens must provide deploymentGroupId or deploymentGroupExternalId. Pending installation retries keep the originally reserved release and CloudFormation stack name, even after a new release is published. Other installation options must remain unchanged.
  • getStats - Get aggregated deployment statistics. Returns total count and breakdown by status.
  • listFilterEnvironments - List distinct effective environments used by deployments. Used for filter dropdowns.
  • listFilterDeploymentGroups - List deployment groups with deployment counts. Used for filter dropdowns.
  • get - Retrieve a deployment by ID.
  • getUpdateOperation - Retrieve a deployment update operation by its durable operation ID.
  • getInfo - Get deployment connection information including command endpoint and resource URLs.
  • import - Import a deployment from resolved setup infrastructure such as CloudFormation, Terraform, or Helm.
  • setFirstPartyDeploymentInputs - Store operator-provided input values on a first-party deployment session token so CLI/local deploys apply them.
  • reportDeploymentSetupProgress - Record that a reserved CloudFormation setup started its stack, or that AWS rolled the stack back before it registered. Called by the template's DeploymentSetupStarted resource with the reservation's deployment credential.
  • createSetupRegistrationOperation - Start a durable setup registration operation for CloudFormation, Terraform, or Helm.
  • getSetupRegistrationOperation - Get setup registration operation status.
  • delete - Delete, detach, or forget a deployment by ID.
  • redeploy - Redeploy a running deployment with the same release and fresh environment variables. Sets status to update-pending.
  • pinRelease - Pin or unpin a running or runtime-failed deployment. Running deployments start an update; failed deployments retry toward the selected release.
  • setReleaseChannel
  • retry - Retry a failed deployment operation. Uses alien-infra's retry mechanisms to resume from exact failure point.
  • getInputs - Get the active input definitions and current non-secret values for a deployment.
  • updateInputs - Update runtime stack inputs, rebuild their environment-variable mappings, and request a deployment update when runtime configuration changes.
  • updateCompute - Update deployment-time compute selections or quota warning overrides and request reconciliation by the hosted manager.
  • updateEnvironmentVariables - Replace a deployment's advanced environment variables. Stack-input-backed variables are write-only through the input endpoint. If the deployment is running and not locked, the status will be changed to update-pending to trigger a deployment.
  • createToken - Create a deployment token (deployment-scoped API key). The deployment must exist before creating a token.
  • listMachines
  • restoreVolume - Replace one replica's persistent volume with a new volume made from a snapshot. The deployment must be running (an update may already be queued or in progress). The replica is stopped while its volume is swapped, and the replaced volume is snapshotted before it is deleted.
  • listVolumeRestores - List a deployment's volume restore requests, newest first.
  • cancelVolumeRestore - Cancel a pending volume restore. Use it when a restore keeps failing: the deployment stops attempting it. A restore whose volume was already swapped still finishes. Allowed in any deployment status, including update-failed.

Domains

  • list - List system domains and workspace domains.
  • create - Create a workspace domain and optional initial endpoints.
  • createEndpoint - Create an endpoint under a workspace domain.
  • get - Get domain by ID.
  • delete - Delete a workspace domain.
  • refresh - Refresh workspace domain verification.

DynamicContainers

  • put - Create or replace a dynamic container in an existing deployment.
  • get - Get one dynamic container's desired generation, status, and internal address.
  • delete - Remove a dynamic container from this deployment.
  • list - List containers created after this deployment was installed.
  • logs - Read recent logs for one dynamic container.

Events

  • list - Retrieve all events.
  • get - Retrieve an event by ID.

Gateways

Incidents

  • list - List authorized incidents without Slack transport metadata.
  • get - Get an authorized incident without Slack transport metadata.

Machines

Managers

  • create - Create a new manager.
  • list - Retrieve all managers.
  • retrySetup - Revoke previous private-manager setup tokens and issue a fresh setup token/config.
  • retry - Retry private-manager setup. Returns a fresh setup action before the internal deployment exists, or requests retry for the internal deployment after it exists.
  • cancelSetup - Cancel pending private-manager setup, revoke setup/runtime tokens, and remove the undeployed manager record.
  • get - Retrieve a manager by ID.
  • delete - Delete a manager by ID.
  • getDomainBinding - Get the custom domain binding for a private manager.
  • updateDomainBinding - Create, update, or remove the custom domain binding for a private manager.
  • getManagementConfig - Get the management configuration for a manager.
  • provision - Enqueue provisioning for a manager by ID.
  • update - Update a manager to a specific release ID or active release.
  • listEvents - Retrieve all events of a manager.
  • generateManagerToken - Generate a short-lived JWT for direct browser → manager communication. Used for fetching command payloads and querying logs without routing sensitive data through the platform API.
  • generateManagerBindingToken - Generate a short-lived deployment-scoped token for resolving opted-in remote bindings through the currently assigned manager.
  • resolveGcpOAuthProvider - Resolve decrypted project-level Google Cloud OAuth provider settings for a manager-side deployment bootstrap.
  • reportHeartbeat - Report Manager health status and metrics.
  • getDeployment - Get deployment details for a private manager (internal deployment platform, status, resources).

Operations

  • listPlugins - List available operations plugins (builtin + custom) for a project, with their operations and risk tiers.
  • publishPlugin - Register a version of a custom operations plugin whose bundle ZIP has already been uploaded to S3 (see POST /plugins/upload-url). Publishing changes no deployment: a release runs the version it declares in operations().
  • createBundleUploadUrl - Get a presigned S3 URL to upload a custom operations plugin bundle ZIP. Upload the ZIP with a PUT to the returned url (sending the given Content-Type), then call POST /plugins to register it.
  • invoke - Invoke a plugin operation against a deployment. Honors the approval rules the deployment's release declares in operations().
  • verifyCheck - One verification poll cycle for an original operation command. Loads that command's authoritative stored result and dispatch-time verification contract, dispatches the frozen read-only poll operation once, and evaluates its frozen success condition. Callers poll this repeatedly per the returned policy.
  • createAccessRequest - Create an access request — either plan-backed (an ai-agent investigation's exact commands) or plan-less (a CLI-originated exact operation or wildcard pattern, resolved and frozen here). Plan-backed requests await the engineer gate (status pending-approval); plan-less requests are queued immediately since the requester is asking for their own access (status queued).
  • listAccessRequests - List a project's access requests, newest first.
  • queueAccessRequest - Engineer gate — approve a pending access request, queuing it for the operator to materialize. Records who queued it.
  • approveAccessRequest - Customer gate — an authenticated workspace member or administrator other than the requester may approve a queued access request. Actor identity comes from authentication; method/source are audit context only.
  • denyAccessRequest - Customer gate — an authenticated workspace member or administrator other than the requester may reject a queued access request. Actor identity comes from authentication.
  • getAccessRequestCoordinates - The customer's kubectl approve command for a queued access request, or null until the operator has materialized the grant CR and reported its coordinates. Polled by the Slack handler to update the access-plan card.
  • getLiveDebugGrant - Find an approved, unexpired access request the caller created whose debug grant matches this deployment and tool (and, when given, namespace/cloudScope). Returns the most recently approved match, or 404 when none is live. Used to reuse an existing grant instead of proposing a new access request. Only the requester's own grants match: a debug session must present a grant its caller requested, so another principal's grant is never returned here.
  • getAccessRequestActivity - The operation commands and debug sessions an access request authorized, with each command's verification outcome. Authorized like getAccessRequest.
  • revokeAccessRequest - Revoke a pending, queued or customer-approved access request. The principal that created the request, or any workspace member or administrator who can read its project, may revoke it. Commands the grant authorized that have not been dispatched are failed; dispatched commands finish. Linked debug sessions are stopped and refuse their next request. Revoking an already revoked request returns it unchanged.
  • getAccessRequest - Get an access request by id.

OperatorManifests

Packages

  • list - List packages with optional filters. Returns packages ordered by creation date (newest first).
  • get - Get details of a specific package.
  • rebuild - Rebuild packages for a project. This will cancel any pending packages and create new ones with auto-incremented versions.
  • cancel - Cancel a pending or building package.

Projects

  • list - Retrieve all projects.
  • create - Create a new project.
  • get - Retrieve a project by ID or name.
  • update - Update a project.
  • delete - Delete a project. The project must have no deployments.
  • getGcpOAuthProvider - Retrieve redacted project-level Google Cloud OAuth provider settings.
  • updateGcpOAuthProvider - Update project-level Google Cloud OAuth provider settings.
  • configureSource - Connect a GitHub repository or Alien template to an existing project.
  • getDeploymentPortalDomain - Get the deployment portal domain binding for a project.
  • createFromTemplate - Create a project by forking alienplatform/alien into your namespace.
  • getTemplateUrls - Get template URLs for deploying setup stacks in this project.
  • getDeploymentLinkSetup - Get the active release stack and portal-visible setup availability for deployment-link configuration.
  • getActiveRelease - Get the production channel's current release. When deploymentId is provided, returns that deployment's effective release: its pin, or its followed channel's current release.
  • previewModelsImpact - Preview which customer model connections a configuration change may affect.
  • setCapabilities - Set the capabilities offered by a Project. Removing a capability prevents new setup without deleting existing customer resources.
  • configureDeployments - Enable deployments for a Project.
  • getAiProviderHeaders - Get static headers added to AI requests for each provider.
  • configureAiProviderHeaders - Replace the static headers added to AI requests for each provider.
  • configureModels - Configure customer-owned model providers without requiring an application Release.
  • configureKeys - Enable customer-owned application encryption without requiring an application Release.
  • configureBuckets - Enable buckets without requiring a project Release.
  • configureRegistry - Enable customer-owned container registries without requiring an application Release.
  • configureRemoteSandbox - Enable a customer-owned sandbox a hosted caller can drive through Remote Bindings. Without a custom image it publishes to every cloud on Alien's default image, which the project then follows. A custom image publishes to AWS; a public one with a linux/amd64 variant also publishes to Azure, and to GCP once Alien has built its GCP image; a private one publishes to Azure from its azureImage and to GCP from its gcpImage.
  • ensureSandboxBaseImageRepository - Ensure the project's private image repository exists and return where to push a private sandbox base image. Name the pushed image as the remote sandbox base image afterwards.
  • getCapabilityOverview - Get safe, server-derived capability status for a Project.
  • getRemoteOperatorSummary - Get the authoritative Remote Operator project summary
  • acceptRemoteOperatorImage - Accept a reported image for a Remote Operator installation
  • acceptRemoteOperatorPermissions - Record that a Remote Operator installation's setup was re-applied
  • getAiUsage
  • getEncryptionUsage
  • getSandboxMetrics

ReleaseChannels

  • list - List release channels
  • create - Create a release channel
  • delete - Delete a release channel

Releases

  • list - Retrieve all releases.
  • create - Create a new release.
  • listBranches - List distinct git branches across releases. Used for filter dropdowns. Empty for deployment and deployment-group tokens.
  • listAuthors - List distinct commit authors across releases. Used for filter dropdowns. Empty for deployment and deployment-group tokens.
  • get - Retrieve a release by ID.
  • listDeployments - List the project's deployments with their rollout state relative to this release.
  • listChannelImpact - List the project's release channels with what each runs now and what promoting this release to it would change.
  • promote

RemoteBindings

Resolve

  • resolve - Resolve manager for a project and platform

Resources

SetupLinks

  • create - Create a customer setup link

SlackIntegration

  • installUrl - Generate the Slack OAuth consent URL for this workspace.
  • status - Return the Slack install for this workspace (if any).
  • listChannels - List public Slack channels for this workspace's install. Used by the dashboard's notification-channel picker.
  • setNotificationChannel - Configure which Slack channel receives ai-agent monitor reports.
  • uninstall - Uninstall the Slack integration for this workspace. Revokes the bot token at Slack and deletes the row.

Sync

  • list - List full deployment records for manager operational loops. This endpoint is intentionally separate from the public deployments list, which returns lightweight UI rows.
  • context - Get computed deployment state and configuration for a manager-side operation without acquiring the deployment reconciliation lock.
  • managementExternalId - Get the AWS sts:ExternalId the deployment's management and remote-bindings roles trust. Only the manager runtime assigned to the deployment can read it.
  • acquire - Acquire a batch of deployments for processing. Used by Manager to atomically lock deployments matching filters. Each deployment in the batch must be released after processing.
  • reconcile - Reconcile deployment state. Push model requests that include a session verify lock ownership. Pull model state reports are accepted as authz-gated agent progress even when they carry an agent-sync session. Accepts full DeploymentState after step() execution.
  • renew
  • release - Release a deployment lock. Must be called after processing an acquired deployment, even if processing failed. This is critical to avoid deadlocks.

User

  • listMemberships - List all workspaces the current user has access to.
  • getProfile - Get the current user's profile and user-scoped onboarding state.
  • updateProfile - Update the current user's profile (display name).
  • completeProfileSetup - Complete the required beta intake and profile setup dialog.
  • createWorkspace - Create a new workspace. The current user will be automatically added as an admin.
  • listGitNamespaces - List all git namespaces (GitHub installations) the current user has access to.
  • syncGitNamespaces - Sync git namespaces from the provider. For GitHub, this fetches all app installations accessible to the user.
  • listGitNamespaceRepositories - List repositories accessible through a git namespace (GitHub installation).

Webhooks

Workspaces

  • list - Retrieve all workspaces.
  • get - Retrieve a workspace by ID.
  • update - Update a workspace.
  • delete - Delete a workspace. The workspace must have no projects and must not be on pay as you go or a contract.
  • listMembers - List all members of a workspace.
  • addMember - Add a member to a workspace by email. The user must already have an account.
  • updateMember - Update a workspace member's role.
  • removeMember - Remove a member from a workspace.
  • getSettings - Read the ai-agent settings for a workspace. Returns defaults (enabled: true) when the workspace has never customized them.
  • updateSettings - Update the ai-agent settings for a workspace. Supports enabled (false turns the ai-agent off so incoming triggers are rejected before any session runs).

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.