@xemahq/app-platform-internal-api-client 0.3.5 → 0.3.11

package/dist/endpoints/apps/apps.d.ts

@@ -11,7 +11,7 @@ export declare const getAppsControllerCreateUrl: () => string;
 export declare const appsControllerCreate: (createAppDto: CreateAppDto, options?: RequestInit) => Promise<AppDtoDataEnvelope>;
 export declare const getAppsControllerListUrl: (params?: AppsControllerListParams) => string;
 /**
- * @summary List Apps (filtered by orgId, projectId, portalOnly, and/or slug).
+ * @summary List Apps (filtered by orgId, projectId, portalOnly, and/or slug). Archived Apps are excluded unless `includeArchived=true`.
  */
 export declare const appsControllerList: (params?: AppsControllerListParams, options?: RequestInit) => Promise<AppDtoDataArrayEnvelope>;
 export declare const getAppsControllerGetByIdUrl: (id: string) => string;

package/dist/endpoints/apps/apps.js

@@ -42,7 +42,7 @@ const getAppsControllerListUrl = (params) => {
 };
 exports.getAppsControllerListUrl = getAppsControllerListUrl;
 /**
- * @summary List Apps (filtered by orgId, projectId, portalOnly, and/or slug).
+ * @summary List Apps (filtered by orgId, projectId, portalOnly, and/or slug). Archived Apps are excluded unless `includeArchived=true`.
  */
 const appsControllerList = async (params, options) => {
     return (0, custom_fetch_1.customFetch)((0, exports.getAppsControllerListUrl)(params), {

package/dist/models/appDto.d.ts

@@ -4,6 +4,7 @@
  * OpenAPI spec version: 0.1.2
  */
 import type { AppLockfileDto } from './appLockfileDto.js';
+import type { AudienceKind } from './audienceKind.js';
 import type { BiomeInstallDto } from './biomeInstallDto.js';
 import type { BrandingConfigDto } from './brandingConfigDto.js';
 import type { CapabilityPolicyOverrideDto } from './capabilityPolicyOverrideDto.js';
@@ -22,13 +23,14 @@ export interface AppDto {
     lockfile: AppLockfileDto;
     installedBiomes: BiomeInstallDto[];
     capabilityPolicy: CapabilityPolicyOverrideDto[];
-    /** @nullable */
-    subdomain: string | null;
+    /** Whether this App is reachable on a public host. The host itself is DERIVED (see `codedAppSubdomain`), never tenant-chosen — this is the switch for WHETHER, not WHERE. */
     subdomainEnabled: boolean;
-    defaultAudience: string;
+    defaultAudience: AudienceKind;
     archived: boolean;
     /** Provisioning ownership marker. `iac` = managed by the declarative control plane (Terraform / xema.yaml); `seeder` = a distribution default; `ui` = hand-managed (or adopted from iac/seeder via a UI edit); `system` = platform-shipped; null = unmanaged/legacy. Lets a console badge an IaC-owned resource and surface an "export as code" affordance. */
     managedBy: ResourceManagedBy | null;
+    /** Whether this App can be handed back to the portal reconciler — the exact precondition of POST /bff/portals/:id/readopt (true iff the row carries the reconciler natural key). Read-only, server-derived. A `ui`-managed App with readoptable=false was hand-created and was never reconciler-owned; with readoptable=true it is an adopted default portal, and readopt restores automatic updates. */
+    readoptable: boolean;
     createdAt: string;
     updatedAt: string;
 }

package/dist/models/appsControllerListParams.d.ts

@@ -7,5 +7,12 @@ export type AppsControllerListParams = {
     orgId?: string;
     projectId?: string;
     slug?: string;
+    /**
+     * Restrict to ORG-scoped Apps (projectId IS NULL).
+     */
     portalOnly?: boolean;
+    /**
+     * Include archived Apps. Default false — an archived App is refused by public ingress and by every external-auth flow, so it is out of the listing unless explicitly asked for.
+     */
+    includeArchived?: boolean;
 };

package/dist/models/codedReleaseRuntimeDto.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * App Runtime API
+ * OpenAPI spec version: 0.1.2
+ */
+export interface CodedReleaseRuntimeDto {
+    /** Repository + tag the build pushed to. A tag is required: a ref without one is indistinguishable from one whose tag was lost in string assembly. */
+    imageRef: string;
+    /**
+       * The manifest digest the registry SERVES at that ref — this is what the workload runs, so a retag cannot move a live app out from under its own release. The ref returned when a build is DISPATCHED is an address the image is expected to occupy, not evidence that anything is there.
+       * @pattern ^sha256:[a-f0-9]{64}$
+       */
+    imageDigest: string;
+    /** The port the app's server listens on inside the container. */
+    containerPort: number;
+    /** HTTP path the readiness and liveness probes GET. Defaults to `/` — the one path a server that serves this app must answer. A Xema convention like `/health/ready` would be a guess about someone else's app, and a wrong probe path leaves the deployment permanently un-ready rather than failing loudly. */
+    healthPath?: string;
+}

package/dist/models/createAppDto.d.ts

@@ -4,10 +4,11 @@
  * OpenAPI spec version: 0.1.2
  */
 import type { AppLockfileDto } from './appLockfileDto.js';
+import type { AudienceKind } from './audienceKind.js';
 import type { BiomeInstallDto } from './biomeInstallDto.js';
 import type { BrandingConfigDto } from './brandingConfigDto.js';
 import type { CapabilityPolicyOverrideDto } from './capabilityPolicyOverrideDto.js';
-import type { CreateAppDtoProjectId } from './createAppDtoProjectId.js';
+import type { SurfaceKind } from './surfaceKind.js';
 export interface CreateAppDto {
     /** Stable slug unique within (orgId, projectId) for project apps, or (orgId) for portals. */
     slug: string;
@@ -16,7 +17,7 @@ export interface CreateAppDto {
        * Project id. Null or absent for org-scoped portals.
        * @nullable
        */
-    projectId?: CreateAppDtoProjectId;
+    projectId?: string | null;
     displayName: string;
     /** Default ExecutionEnvironment slug (e.g. `public-session`). */
     defaultZone: string;
@@ -24,9 +25,10 @@ export interface CreateAppDto {
     lockfile: AppLockfileDto;
     installedBiomes: BiomeInstallDto[];
     capabilityPolicy: CapabilityPolicyOverrideDto[];
-    /** @nullable */
-    subdomain?: string | null;
+    /** Whether this App is reachable on a public host. The host itself is DERIVED, never tenant-chosen — this is the switch for WHETHER, not WHERE. */
     subdomainEnabled?: boolean;
-    defaultAudience?: string;
+    defaultAudience?: AudienceKind;
     archived?: boolean;
+    /** Authoring tier. `declared` (the default) and `composed` Apps ARE their JSON definition. A `coded` App is one the platform hosts but does not author — a Webapp Studio session builds a container image from the user's own repo, and every release of it carries that image coordinate. Immutable after creation: the tier decides what a release IS, so changing it would leave existing releases describing the wrong thing. */
+    surface?: SurfaceKind;
 }

package/dist/models/index.d.ts

@@ -38,9 +38,9 @@ export * from './biomeInstallDtoConfiguration';
 export * from './brandingConfigDto';
 export * from './brandingConfigDtoCssTokens';
 export * from './capabilityPolicyOverrideDto';
+export * from './codedReleaseRuntimeDto';
 export * from './createAppClientDto';
 export * from './createAppDto';
-export * from './createAppDtoProjectId';
 export * from './createAudiencePolicyDto';
 export * from './createdAppClientDto';
 export * from './createdAppClientDtoDataEnvelope';
@@ -61,6 +61,7 @@ export * from './prepareAppReleaseDtoSourceArtifacts';
 export * from './releaseOrgDto';
 export * from './resourceManagedBy';
 export * from './spaceKind';
+export * from './surfaceKind';
 export * from './updateAppDto';
 export * from './updateAudiencePolicyDto';
 export * from './updateAudiencePolicyDtoRateLimitPerHourPerSubject';

package/dist/models/index.js

@@ -55,9 +55,9 @@ __exportStar(require("./biomeInstallDtoConfiguration"), exports);
 __exportStar(require("./brandingConfigDto"), exports);
 __exportStar(require("./brandingConfigDtoCssTokens"), exports);
 __exportStar(require("./capabilityPolicyOverrideDto"), exports);
+__exportStar(require("./codedReleaseRuntimeDto"), exports);
 __exportStar(require("./createAppClientDto"), exports);
 __exportStar(require("./createAppDto"), exports);
-__exportStar(require("./createAppDtoProjectId"), exports);
 __exportStar(require("./createAudiencePolicyDto"), exports);
 __exportStar(require("./createdAppClientDto"), exports);
 __exportStar(require("./createdAppClientDtoDataEnvelope"), exports);
@@ -78,6 +78,7 @@ __exportStar(require("./prepareAppReleaseDtoSourceArtifacts"), exports);
 __exportStar(require("./releaseOrgDto"), exports);
 __exportStar(require("./resourceManagedBy"), exports);
 __exportStar(require("./spaceKind"), exports);
+__exportStar(require("./surfaceKind"), exports);
 __exportStar(require("./updateAppDto"), exports);
 __exportStar(require("./updateAudiencePolicyDto"), exports);
 __exportStar(require("./updateAudiencePolicyDtoRateLimitPerHourPerSubject"), exports);

package/dist/models/prepareAppReleaseDto.d.ts

@@ -4,6 +4,7 @@
  * OpenAPI spec version: 0.1.2
  */
 import type { AppLockfileDto } from './appLockfileDto.js';
+import type { CodedReleaseRuntimeDto } from './codedReleaseRuntimeDto.js';
 import type { PrepareAppReleaseDtoAudienceSnapshot } from './prepareAppReleaseDtoAudienceSnapshot.js';
 import type { PrepareAppReleaseDtoDefinition } from './prepareAppReleaseDtoDefinition.js';
 import type { PrepareAppReleaseDtoPolicySnapshot } from './prepareAppReleaseDtoPolicySnapshot.js';
@@ -24,4 +25,6 @@ export interface PrepareAppReleaseDto {
     sourceArtifacts: PrepareAppReleaseDtoSourceArtifacts;
     audienceSnapshot: PrepareAppReleaseDtoAudienceSnapshot;
     policySnapshot: PrepareAppReleaseDtoPolicySnapshot;
+    /** Container coordinate. REQUIRED when the App's surface is `coded` and REFUSED otherwise — the surface decides what a release IS, and an image on a declared release would read as deployable to anything checking the column instead of the surface. */
+    codedRuntime?: CodedReleaseRuntimeDto;
 }

package/dist/models/surfaceKind.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * App Runtime API
+ * OpenAPI spec version: 0.1.2
+ */
+/**
+ * Authoring tier. `declared` (the default) and `composed` Apps ARE their JSON definition. A `coded` App is one the platform hosts but does not author — a Webapp Studio session builds a container image from the user's own repo, and every release of it carries that image coordinate. Immutable after creation: the tier decides what a release IS, so changing it would leave existing releases describing the wrong thing.
+ */
+export type SurfaceKind = typeof SurfaceKind[keyof typeof SurfaceKind];
+export declare const SurfaceKind: {
+    readonly declared: "declared";
+    readonly composed: "composed";
+    readonly coded: "coded";
+};

package/dist/models/surfaceKind.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * App Runtime API
+ * OpenAPI spec version: 0.1.2
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SurfaceKind = void 0;
+exports.SurfaceKind = {
+    declared: 'declared',
+    composed: 'composed',
+    coded: 'coded',
+};

package/dist/models/updateAppDto.d.ts

@@ -4,6 +4,7 @@
  * OpenAPI spec version: 0.1.2
  */
 import type { AppLockfileDto } from './appLockfileDto.js';
+import type { AudienceKind } from './audienceKind.js';
 import type { BiomeInstallDto } from './biomeInstallDto.js';
 import type { BrandingConfigDto } from './brandingConfigDto.js';
 import type { CapabilityPolicyOverrideDto } from './capabilityPolicyOverrideDto.js';
@@ -14,8 +15,7 @@ export interface UpdateAppDto {
     lockfile?: AppLockfileDto;
     installedBiomes?: BiomeInstallDto[];
     capabilityPolicy?: CapabilityPolicyOverrideDto[];
-    /** @nullable */
-    subdomain?: string | null;
+    /** Whether this App is reachable on a public host. The host itself is DERIVED, never tenant-chosen — this is the switch for WHETHER, not WHERE. */
     subdomainEnabled?: boolean;
-    defaultAudience?: string;
+    defaultAudience?: AudienceKind;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xemahq/app-platform-internal-api-client",
-  "version": "0.3.5",
+  "version": "0.3.11",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [

package/dist/models/createAppDtoProjectId.d.ts

@@ -1,12 +0,0 @@
-/**
- * Generated by @xemahq/api-client-generator — do not edit manually.
- * App Runtime API
- * OpenAPI spec version: 0.1.2
- */
-/**
- * Project id. Null or absent for org-scoped portals.
- * @nullable
- */
-export type CreateAppDtoProjectId = {
-    [key: string]: unknown;
-} | null;