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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,7 +3,7 @@
3
3
  * App Runtime API
4
4
  * OpenAPI spec version: 0.1.2
5
5
  */
6
- import type { AppClientDtoDataArrayEnvelope, AppClientDtoDataEnvelope, AppDtoDataArrayEnvelope, AppDtoDataEnvelope, AppReleaseDtoDataArrayEnvelope, AppReleaseDtoDataEnvelope, AudiencePolicyDtoDataArrayEnvelope, AudiencePolicyDtoDataEnvelope, CreateAppClientDto, CreateAudiencePolicyDto, CreatePortalDto, CreateProjectAppDto, CreatedAppClientDtoDataEnvelope, PortalDetailDtoDataEnvelope, ProjectAppsControllerListParams, UpdateAudiencePolicyDto, UpdatePortalDto } from '../../models';
6
+ import type { AppClientDtoDataArrayEnvelope, AppClientDtoDataEnvelope, AppDtoDataArrayEnvelope, AppDtoDataEnvelope, AppDtoPaginatedEnvelope, AppReleaseDtoDataArrayEnvelope, AppReleaseDtoDataEnvelope, AudiencePolicyDtoDataArrayEnvelope, AudiencePolicyDtoDataEnvelope, CreateAppClientDto, CreateAudiencePolicyDto, CreatePortalDto, CreateProjectAppDto, CreatedAppClientDtoDataEnvelope, InstallPortalBiomeDto, PortalDetailDtoDataEnvelope, PortalsControllerListParams, ProjectAppsControllerListParams, UnarchivePortalDto, UpdateAudiencePolicyDto, UpdatePortalDto } from '../../models';
7
7
  export declare const getProjectAppsControllerCreateUrl: () => string;
8
8
  /**
9
9
  * @summary Create an App in the caller org + named project.
@@ -11,7 +11,7 @@ export declare const getProjectAppsControllerCreateUrl: () => string;
11
11
  export declare const projectAppsControllerCreate: (createProjectAppDto: CreateProjectAppDto, options?: RequestInit) => Promise<AppDtoDataEnvelope>;
12
12
  export declare const getProjectAppsControllerListUrl: (params?: ProjectAppsControllerListParams) => string;
13
13
  /**
14
- * @summary List Apps in the caller org (optionally filtered by project/slug).
14
+ * @summary List Apps in the caller org (optionally filtered by project/slug). Archived Apps are excluded unless `includeArchived=true`.
15
15
  */
16
16
  export declare const projectAppsControllerList: (params?: ProjectAppsControllerListParams, options?: RequestInit) => Promise<AppDtoDataArrayEnvelope>;
17
17
  export declare const getProjectAppsControllerGetByIdUrl: (id: string) => string;
@@ -69,11 +69,11 @@ export declare const getProjectAudiencePoliciesControllerDeleteUrl: (id: string)
69
69
  * @summary Delete an AudiencePolicy owned by the caller org.
70
70
  */
71
71
  export declare const projectAudiencePoliciesControllerDelete: (id: string, options?: RequestInit) => Promise<void>;
72
- export declare const getPortalsControllerListUrl: () => string;
72
+ export declare const getPortalsControllerListUrl: (params?: PortalsControllerListParams) => string;
73
73
  /**
74
- * @summary List the portals the calling user may see in the caller org (visibility-filtered).
74
+ * @summary List the portals the calling user may see in the caller org (visibility-filtered, paginated).
75
75
  */
76
- export declare const portalsControllerList: (options?: RequestInit) => Promise<AppDtoDataArrayEnvelope>;
76
+ export declare const portalsControllerList: (params?: PortalsControllerListParams, options?: RequestInit) => Promise<AppDtoPaginatedEnvelope>;
77
77
  export declare const getPortalsControllerCreateUrl: () => string;
78
78
  /**
79
79
  * @summary Create an org-scoped portal (portal-admin only).
@@ -89,8 +89,38 @@ export declare const getPortalsControllerUpdateUrl: (id: string) => string;
89
89
  * @summary Update a portal owned by the caller org (portal-admin only).
90
90
  */
91
91
  export declare const portalsControllerUpdate: (id: string, updatePortalDto: UpdatePortalDto, options?: RequestInit) => Promise<AppDtoDataEnvelope>;
92
+ export declare const getPortalsControllerRemoveUrl: (id: string) => string;
93
+ /**
94
+ * @summary Hard-delete a UI-owned portal (portal-admin only). Cascades to its releases, app-clients and external subjects. Use archive for a reversible retire; a seeder/IaC/system-owned portal is refused (409) because its producer would recreate it.
95
+ */
96
+ export declare const portalsControllerRemove: (id: string, options?: RequestInit) => Promise<void>;
92
97
  export declare const getPortalsControllerArchiveUrl: (id: string) => string;
93
98
  /**
94
- * @summary Archive a portal owned by the caller org (portal-admin only).
99
+ * @summary Archive a portal owned by the caller org (portal-admin only). Reversible via `POST :id/unarchive`.
95
100
  */
96
101
  export declare const portalsControllerArchive: (id: string, options?: RequestInit) => Promise<AppDtoDataEnvelope>;
102
+ export declare const getPortalsControllerUnarchiveUrl: (id: string) => string;
103
+ /**
104
+ * @summary Un-archive a portal owned by the caller org (portal-admin only). Re-registers its PDP access — `org-shared` unless a block is supplied.
105
+ */
106
+ export declare const portalsControllerUnarchive: (id: string, unarchivePortalDto: UnarchivePortalDto, options?: RequestInit) => Promise<AppDtoDataEnvelope>;
107
+ export declare const getPortalsControllerReadoptUrl: (id: string) => string;
108
+ /**
109
+ * @summary Hand a UI-adopted default portal back to the reconciler (portal-admin only), so it resumes tracking the installed web biomes.
110
+ */
111
+ export declare const portalsControllerReadopt: (id: string, options?: RequestInit) => Promise<AppDtoDataEnvelope>;
112
+ export declare const getPortalsControllerInstallBiomeUrl: (id: string) => string;
113
+ /**
114
+ * @summary Install one biome on a portal (portal-admin only). Idempotent per ref; serialized against concurrent installs by a per-portal lock. Returns 422 for a ref no web biome is registered for.
115
+ */
116
+ export declare const portalsControllerInstallBiome: (id: string, installPortalBiomeDto: InstallPortalBiomeDto, options?: RequestInit) => Promise<AppDtoDataEnvelope>;
117
+ export declare const getPortalsControllerUninstallBiomeUrl: (id: string, encodedRef: string) => string;
118
+ /**
119
+ * @summary Uninstall one biome from a portal (portal-admin only). 404s a ref the portal does not carry, rather than reporting a no-op as success.
120
+ */
121
+ export declare const portalsControllerUninstallBiome: (id: string, encodedRef: string, options?: RequestInit) => Promise<AppDtoDataEnvelope>;
122
+ export declare const getPortalsControllerRefreshLockfileUrl: (id: string) => string;
123
+ /**
124
+ * @summary Refresh a portal lockfile (portal-admin only). Re-pins kernel + installed biomes via the kernel Lockfile Resolver. Returns 422 LOCKFILE_RESOLVER_FAILED on any unsatisfiable constraint, malformed ref, or unreachable upstream.
125
+ */
126
+ export declare const portalsControllerRefreshLockfile: (id: string, options?: RequestInit) => Promise<AppDtoDataEnvelope>;
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.portalsControllerArchive = exports.getPortalsControllerArchiveUrl = exports.portalsControllerUpdate = exports.getPortalsControllerUpdateUrl = exports.portalsControllerGetOne = exports.getPortalsControllerGetOneUrl = exports.portalsControllerCreate = exports.getPortalsControllerCreateUrl = exports.portalsControllerList = exports.getPortalsControllerListUrl = exports.projectAudiencePoliciesControllerDelete = exports.getProjectAudiencePoliciesControllerDeleteUrl = exports.projectAudiencePoliciesControllerUpdate = exports.getProjectAudiencePoliciesControllerUpdateUrl = exports.projectAudiencePoliciesControllerList = exports.getProjectAudiencePoliciesControllerListUrl = exports.projectAudiencePoliciesControllerCreate = exports.getProjectAudiencePoliciesControllerCreateUrl = exports.projectAppReleasesControllerRollback = exports.getProjectAppReleasesControllerRollbackUrl = exports.projectAppReleasesControllerListHistory = exports.getProjectAppReleasesControllerListHistoryUrl = exports.projectAppReleasesControllerGetLive = exports.getProjectAppReleasesControllerGetLiveUrl = exports.projectAppClientsControllerRevoke = exports.getProjectAppClientsControllerRevokeUrl = exports.projectAppClientsControllerList = exports.getProjectAppClientsControllerListUrl = exports.projectAppClientsControllerCreate = exports.getProjectAppClientsControllerCreateUrl = exports.projectAppsControllerGetById = exports.getProjectAppsControllerGetByIdUrl = exports.projectAppsControllerList = exports.getProjectAppsControllerListUrl = exports.projectAppsControllerCreate = exports.getProjectAppsControllerCreateUrl = void 0;
3
+ exports.portalsControllerRefreshLockfile = exports.getPortalsControllerRefreshLockfileUrl = exports.portalsControllerUninstallBiome = exports.getPortalsControllerUninstallBiomeUrl = exports.portalsControllerInstallBiome = exports.getPortalsControllerInstallBiomeUrl = exports.portalsControllerReadopt = exports.getPortalsControllerReadoptUrl = exports.portalsControllerUnarchive = exports.getPortalsControllerUnarchiveUrl = exports.portalsControllerArchive = exports.getPortalsControllerArchiveUrl = exports.portalsControllerRemove = exports.getPortalsControllerRemoveUrl = exports.portalsControllerUpdate = exports.getPortalsControllerUpdateUrl = exports.portalsControllerGetOne = exports.getPortalsControllerGetOneUrl = exports.portalsControllerCreate = exports.getPortalsControllerCreateUrl = exports.portalsControllerList = exports.getPortalsControllerListUrl = exports.projectAudiencePoliciesControllerDelete = exports.getProjectAudiencePoliciesControllerDeleteUrl = exports.projectAudiencePoliciesControllerUpdate = exports.getProjectAudiencePoliciesControllerUpdateUrl = exports.projectAudiencePoliciesControllerList = exports.getProjectAudiencePoliciesControllerListUrl = exports.projectAudiencePoliciesControllerCreate = exports.getProjectAudiencePoliciesControllerCreateUrl = exports.projectAppReleasesControllerRollback = exports.getProjectAppReleasesControllerRollbackUrl = exports.projectAppReleasesControllerListHistory = exports.getProjectAppReleasesControllerListHistoryUrl = exports.projectAppReleasesControllerGetLive = exports.getProjectAppReleasesControllerGetLiveUrl = exports.projectAppClientsControllerRevoke = exports.getProjectAppClientsControllerRevokeUrl = exports.projectAppClientsControllerList = exports.getProjectAppClientsControllerListUrl = exports.projectAppClientsControllerCreate = exports.getProjectAppClientsControllerCreateUrl = exports.projectAppsControllerGetById = exports.getProjectAppsControllerGetByIdUrl = exports.projectAppsControllerList = exports.getProjectAppsControllerListUrl = exports.projectAppsControllerCreate = exports.getProjectAppsControllerCreateUrl = void 0;
4
4
  const custom_fetch_1 = require("../../custom-fetch");
5
5
  const getProjectAppsControllerCreateUrl = () => {
6
6
  return `/bff/apps`;
@@ -42,7 +42,7 @@ const getProjectAppsControllerListUrl = (params) => {
42
42
  };
43
43
  exports.getProjectAppsControllerListUrl = getProjectAppsControllerListUrl;
44
44
  /**
45
- * @summary List Apps in the caller org (optionally filtered by project/slug).
45
+ * @summary List Apps in the caller org (optionally filtered by project/slug). Archived Apps are excluded unless `includeArchived=true`.
46
46
  */
47
47
  const projectAppsControllerList = async (params, options) => {
48
48
  return (0, custom_fetch_1.customFetch)((0, exports.getProjectAppsControllerListUrl)(params), {
@@ -211,15 +211,34 @@ const projectAudiencePoliciesControllerDelete = async (id, options) => {
211
211
  });
212
212
  };
213
213
  exports.projectAudiencePoliciesControllerDelete = projectAudiencePoliciesControllerDelete;
214
- const getPortalsControllerListUrl = () => {
215
- return `/bff/portals`;
214
+ const getPortalsControllerListUrl = (params) => {
215
+ const normalizedParams = new URLSearchParams();
216
+ Object.entries(params || {}).forEach(([key, value]) => {
217
+ if (value === undefined)
218
+ return;
219
+ if (value === null) {
220
+ normalizedParams.append(key, 'null');
221
+ return;
222
+ }
223
+ if (Array.isArray(value)) {
224
+ for (const item of value) {
225
+ if (item === undefined || item === null)
226
+ continue;
227
+ normalizedParams.append(key, item.toString());
228
+ }
229
+ return;
230
+ }
231
+ normalizedParams.append(key, value.toString());
232
+ });
233
+ const stringifiedParams = normalizedParams.toString();
234
+ return stringifiedParams.length > 0 ? `/bff/portals?${stringifiedParams}` : `/bff/portals`;
216
235
  };
217
236
  exports.getPortalsControllerListUrl = getPortalsControllerListUrl;
218
237
  /**
219
- * @summary List the portals the calling user may see in the caller org (visibility-filtered).
238
+ * @summary List the portals the calling user may see in the caller org (visibility-filtered, paginated).
220
239
  */
221
- const portalsControllerList = async (options) => {
222
- return (0, custom_fetch_1.customFetch)((0, exports.getPortalsControllerListUrl)(), {
240
+ const portalsControllerList = async (params, options) => {
241
+ return (0, custom_fetch_1.customFetch)((0, exports.getPortalsControllerListUrl)(params), {
223
242
  ...options,
224
243
  method: 'GET'
225
244
  });
@@ -271,12 +290,26 @@ const portalsControllerUpdate = async (id, updatePortalDto, options) => {
271
290
  });
272
291
  };
273
292
  exports.portalsControllerUpdate = portalsControllerUpdate;
293
+ const getPortalsControllerRemoveUrl = (id) => {
294
+ return `/bff/portals/${id}`;
295
+ };
296
+ exports.getPortalsControllerRemoveUrl = getPortalsControllerRemoveUrl;
297
+ /**
298
+ * @summary Hard-delete a UI-owned portal (portal-admin only). Cascades to its releases, app-clients and external subjects. Use archive for a reversible retire; a seeder/IaC/system-owned portal is refused (409) because its producer would recreate it.
299
+ */
300
+ const portalsControllerRemove = async (id, options) => {
301
+ return (0, custom_fetch_1.customFetch)((0, exports.getPortalsControllerRemoveUrl)(id), {
302
+ ...options,
303
+ method: 'DELETE'
304
+ });
305
+ };
306
+ exports.portalsControllerRemove = portalsControllerRemove;
274
307
  const getPortalsControllerArchiveUrl = (id) => {
275
308
  return `/bff/portals/${id}/archive`;
276
309
  };
277
310
  exports.getPortalsControllerArchiveUrl = getPortalsControllerArchiveUrl;
278
311
  /**
279
- * @summary Archive a portal owned by the caller org (portal-admin only).
312
+ * @summary Archive a portal owned by the caller org (portal-admin only). Reversible via `POST :id/unarchive`.
280
313
  */
281
314
  const portalsControllerArchive = async (id, options) => {
282
315
  return (0, custom_fetch_1.customFetch)((0, exports.getPortalsControllerArchiveUrl)(id), {
@@ -285,3 +318,77 @@ const portalsControllerArchive = async (id, options) => {
285
318
  });
286
319
  };
287
320
  exports.portalsControllerArchive = portalsControllerArchive;
321
+ const getPortalsControllerUnarchiveUrl = (id) => {
322
+ return `/bff/portals/${id}/unarchive`;
323
+ };
324
+ exports.getPortalsControllerUnarchiveUrl = getPortalsControllerUnarchiveUrl;
325
+ /**
326
+ * @summary Un-archive a portal owned by the caller org (portal-admin only). Re-registers its PDP access — `org-shared` unless a block is supplied.
327
+ */
328
+ const portalsControllerUnarchive = async (id, unarchivePortalDto, options) => {
329
+ return (0, custom_fetch_1.customFetch)((0, exports.getPortalsControllerUnarchiveUrl)(id), {
330
+ ...options,
331
+ method: 'POST',
332
+ headers: { 'Content-Type': 'application/json', ...options?.headers },
333
+ body: JSON.stringify(unarchivePortalDto)
334
+ });
335
+ };
336
+ exports.portalsControllerUnarchive = portalsControllerUnarchive;
337
+ const getPortalsControllerReadoptUrl = (id) => {
338
+ return `/bff/portals/${id}/readopt`;
339
+ };
340
+ exports.getPortalsControllerReadoptUrl = getPortalsControllerReadoptUrl;
341
+ /**
342
+ * @summary Hand a UI-adopted default portal back to the reconciler (portal-admin only), so it resumes tracking the installed web biomes.
343
+ */
344
+ const portalsControllerReadopt = async (id, options) => {
345
+ return (0, custom_fetch_1.customFetch)((0, exports.getPortalsControllerReadoptUrl)(id), {
346
+ ...options,
347
+ method: 'POST'
348
+ });
349
+ };
350
+ exports.portalsControllerReadopt = portalsControllerReadopt;
351
+ const getPortalsControllerInstallBiomeUrl = (id) => {
352
+ return `/bff/portals/${id}/biomes`;
353
+ };
354
+ exports.getPortalsControllerInstallBiomeUrl = getPortalsControllerInstallBiomeUrl;
355
+ /**
356
+ * @summary Install one biome on a portal (portal-admin only). Idempotent per ref; serialized against concurrent installs by a per-portal lock. Returns 422 for a ref no web biome is registered for.
357
+ */
358
+ const portalsControllerInstallBiome = async (id, installPortalBiomeDto, options) => {
359
+ return (0, custom_fetch_1.customFetch)((0, exports.getPortalsControllerInstallBiomeUrl)(id), {
360
+ ...options,
361
+ method: 'POST',
362
+ headers: { 'Content-Type': 'application/json', ...options?.headers },
363
+ body: JSON.stringify(installPortalBiomeDto)
364
+ });
365
+ };
366
+ exports.portalsControllerInstallBiome = portalsControllerInstallBiome;
367
+ const getPortalsControllerUninstallBiomeUrl = (id, encodedRef) => {
368
+ return `/bff/portals/${id}/biomes/${encodedRef}`;
369
+ };
370
+ exports.getPortalsControllerUninstallBiomeUrl = getPortalsControllerUninstallBiomeUrl;
371
+ /**
372
+ * @summary Uninstall one biome from a portal (portal-admin only). 404s a ref the portal does not carry, rather than reporting a no-op as success.
373
+ */
374
+ const portalsControllerUninstallBiome = async (id, encodedRef, options) => {
375
+ return (0, custom_fetch_1.customFetch)((0, exports.getPortalsControllerUninstallBiomeUrl)(id, encodedRef), {
376
+ ...options,
377
+ method: 'DELETE'
378
+ });
379
+ };
380
+ exports.portalsControllerUninstallBiome = portalsControllerUninstallBiome;
381
+ const getPortalsControllerRefreshLockfileUrl = (id) => {
382
+ return `/bff/portals/${id}/lockfile/refresh`;
383
+ };
384
+ exports.getPortalsControllerRefreshLockfileUrl = getPortalsControllerRefreshLockfileUrl;
385
+ /**
386
+ * @summary Refresh a portal lockfile (portal-admin only). Re-pins kernel + installed biomes via the kernel Lockfile Resolver. Returns 422 LOCKFILE_RESOLVER_FAILED on any unsatisfiable constraint, malformed ref, or unreachable upstream.
387
+ */
388
+ const portalsControllerRefreshLockfile = async (id, options) => {
389
+ return (0, custom_fetch_1.customFetch)((0, exports.getPortalsControllerRefreshLockfileUrl)(id), {
390
+ ...options,
391
+ method: 'POST'
392
+ });
393
+ };
394
+ exports.portalsControllerRefreshLockfile = portalsControllerRefreshLockfile;
@@ -4,6 +4,7 @@
4
4
  * OpenAPI spec version: 0.1.2
5
5
  */
6
6
  import type { AppLockfileDto } from './appLockfileDto.js';
7
+ import type { AudienceKind } from './audienceKind.js';
7
8
  import type { BiomeInstallDto } from './biomeInstallDto.js';
8
9
  import type { BrandingConfigDto } from './brandingConfigDto.js';
9
10
  import type { CapabilityPolicyOverrideDto } from './capabilityPolicyOverrideDto.js';
@@ -22,13 +23,14 @@ export interface AppDto {
22
23
  lockfile: AppLockfileDto;
23
24
  installedBiomes: BiomeInstallDto[];
24
25
  capabilityPolicy: CapabilityPolicyOverrideDto[];
25
- /** @nullable */
26
- subdomain: string | null;
26
+ /** 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. */
27
27
  subdomainEnabled: boolean;
28
- defaultAudience: string;
28
+ defaultAudience: AudienceKind;
29
29
  archived: boolean;
30
30
  /** 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. */
31
31
  managedBy: ResourceManagedBy | null;
32
+ /** 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. */
33
+ readoptable: boolean;
32
34
  createdAt: string;
33
35
  updatedAt: string;
34
36
  }
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Generated by @xemahq/api-client-generator — do not edit manually.
3
+ * App Runtime API
4
+ * OpenAPI spec version: 0.1.2
5
+ */
6
+ import type { AppDto } from './appDto.js';
7
+ import type { PaginationMeta } from './paginationMeta.js';
8
+ export interface AppDtoPaginatedEnvelope {
9
+ data: AppDto[];
10
+ pagination: PaginationMeta;
11
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -4,6 +4,7 @@
4
4
  * OpenAPI spec version: 0.1.2
5
5
  */
6
6
  import type { AppLockfileDto } from './appLockfileDto.js';
7
+ import type { AudienceKind } from './audienceKind.js';
7
8
  import type { BiomeInstallDto } from './biomeInstallDto.js';
8
9
  import type { BrandingConfigDto } from './brandingConfigDto.js';
9
10
  import type { CapabilityPolicyOverrideDto } from './capabilityPolicyOverrideDto.js';
@@ -18,10 +19,9 @@ export interface CreatePortalDto {
18
19
  lockfile: AppLockfileDto;
19
20
  installedBiomes: BiomeInstallDto[];
20
21
  capabilityPolicy: CapabilityPolicyOverrideDto[];
21
- /** @nullable */
22
- subdomain?: string | null;
22
+ /** 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. */
23
23
  subdomainEnabled?: boolean;
24
- defaultAudience?: string;
24
+ defaultAudience?: AudienceKind;
25
25
  archived?: boolean;
26
26
  access?: PortalAccessDto;
27
27
  }
@@ -4,10 +4,11 @@
4
4
  * OpenAPI spec version: 0.1.2
5
5
  */
6
6
  import type { AppLockfileDto } from './appLockfileDto.js';
7
+ import type { AudienceKind } from './audienceKind.js';
7
8
  import type { BiomeInstallDto } from './biomeInstallDto.js';
8
9
  import type { BrandingConfigDto } from './brandingConfigDto.js';
9
10
  import type { CapabilityPolicyOverrideDto } from './capabilityPolicyOverrideDto.js';
10
- import type { CreateProjectAppDtoProjectId } from './createProjectAppDtoProjectId.js';
11
+ import type { SurfaceKind } from './surfaceKind.js';
11
12
  export interface CreateProjectAppDto {
12
13
  /** Stable slug unique within (orgId, projectId) for project apps, or (orgId) for portals. */
13
14
  slug: string;
@@ -15,7 +16,7 @@ export interface CreateProjectAppDto {
15
16
  * Project id. Null or absent for org-scoped portals.
16
17
  * @nullable
17
18
  */
18
- projectId?: CreateProjectAppDtoProjectId;
19
+ projectId?: string | null;
19
20
  displayName: string;
20
21
  /** Default ExecutionEnvironment slug (e.g. `public-session`). */
21
22
  defaultZone: string;
@@ -23,9 +24,10 @@ export interface CreateProjectAppDto {
23
24
  lockfile: AppLockfileDto;
24
25
  installedBiomes: BiomeInstallDto[];
25
26
  capabilityPolicy: CapabilityPolicyOverrideDto[];
26
- /** @nullable */
27
- subdomain?: string | null;
27
+ /** 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. */
28
28
  subdomainEnabled?: boolean;
29
- defaultAudience?: string;
29
+ defaultAudience?: AudienceKind;
30
30
  archived?: boolean;
31
+ /** 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. */
32
+ surface?: SurfaceKind;
31
33
  }
@@ -8,6 +8,7 @@ export * from './appClientDtoRevokedAt';
8
8
  export * from './appDto';
9
9
  export * from './appDtoDataArrayEnvelope';
10
10
  export * from './appDtoDataEnvelope';
11
+ export * from './appDtoPaginatedEnvelope';
11
12
  export * from './appLockfileDto';
12
13
  export * from './appLockfileDtoAgents';
13
14
  export * from './appLockfileDtoBiomes';
@@ -42,7 +43,6 @@ export * from './createAppClientDto';
42
43
  export * from './createAudiencePolicyDto';
43
44
  export * from './createPortalDto';
44
45
  export * from './createProjectAppDto';
45
- export * from './createProjectAppDtoProjectId';
46
46
  export * from './createPublicSessionDto';
47
47
  export * from './createdAppClientDto';
48
48
  export * from './createdAppClientDtoDataEnvelope';
@@ -58,13 +58,17 @@ export * from './delegatedSessionStatusDto';
58
58
  export * from './delegatedSessionStatusDtoDataEnvelope';
59
59
  export * from './delegatedSessionStatusDtoExternalSubjectId';
60
60
  export * from './delegatedSessionStatusDtoRevokedAt';
61
+ export * from './installPortalBiomeDto';
62
+ export * from './installPortalBiomeDtoConfiguration';
61
63
  export * from './oidcAuthDto';
62
64
  export * from './oidcAuthResultDto';
63
65
  export * from './oidcAuthResultDtoDataEnvelope';
66
+ export * from './paginationMeta';
64
67
  export * from './portalAccessDto';
65
68
  export * from './portalDetailDto';
66
69
  export * from './portalDetailDtoDataEnvelope';
67
70
  export * from './portalShareDto';
71
+ export * from './portalsControllerListParams';
68
72
  export * from './projectAppsControllerListParams';
69
73
  export * from './requestMagicLinkDto';
70
74
  export * from './requestMagicLinkResultDto';
@@ -72,7 +76,9 @@ export * from './requestMagicLinkResultDtoDataEnvelope';
72
76
  export * from './resourceManagedBy';
73
77
  export * from './resourceVisibilityPattern';
74
78
  export * from './subjectKind';
79
+ export * from './surfaceKind';
75
80
  export * from './tokenClass';
81
+ export * from './unarchivePortalDto';
76
82
  export * from './updateAudiencePolicyDto';
77
83
  export * from './updateAudiencePolicyDtoRateLimitPerHourPerSubject';
78
84
  export * from './updatePortalDto';
@@ -25,6 +25,7 @@ __exportStar(require("./appClientDtoRevokedAt"), exports);
25
25
  __exportStar(require("./appDto"), exports);
26
26
  __exportStar(require("./appDtoDataArrayEnvelope"), exports);
27
27
  __exportStar(require("./appDtoDataEnvelope"), exports);
28
+ __exportStar(require("./appDtoPaginatedEnvelope"), exports);
28
29
  __exportStar(require("./appLockfileDto"), exports);
29
30
  __exportStar(require("./appLockfileDtoAgents"), exports);
30
31
  __exportStar(require("./appLockfileDtoBiomes"), exports);
@@ -59,7 +60,6 @@ __exportStar(require("./createAppClientDto"), exports);
59
60
  __exportStar(require("./createAudiencePolicyDto"), exports);
60
61
  __exportStar(require("./createPortalDto"), exports);
61
62
  __exportStar(require("./createProjectAppDto"), exports);
62
- __exportStar(require("./createProjectAppDtoProjectId"), exports);
63
63
  __exportStar(require("./createPublicSessionDto"), exports);
64
64
  __exportStar(require("./createdAppClientDto"), exports);
65
65
  __exportStar(require("./createdAppClientDtoDataEnvelope"), exports);
@@ -75,13 +75,17 @@ __exportStar(require("./delegatedSessionStatusDto"), exports);
75
75
  __exportStar(require("./delegatedSessionStatusDtoDataEnvelope"), exports);
76
76
  __exportStar(require("./delegatedSessionStatusDtoExternalSubjectId"), exports);
77
77
  __exportStar(require("./delegatedSessionStatusDtoRevokedAt"), exports);
78
+ __exportStar(require("./installPortalBiomeDto"), exports);
79
+ __exportStar(require("./installPortalBiomeDtoConfiguration"), exports);
78
80
  __exportStar(require("./oidcAuthDto"), exports);
79
81
  __exportStar(require("./oidcAuthResultDto"), exports);
80
82
  __exportStar(require("./oidcAuthResultDtoDataEnvelope"), exports);
83
+ __exportStar(require("./paginationMeta"), exports);
81
84
  __exportStar(require("./portalAccessDto"), exports);
82
85
  __exportStar(require("./portalDetailDto"), exports);
83
86
  __exportStar(require("./portalDetailDtoDataEnvelope"), exports);
84
87
  __exportStar(require("./portalShareDto"), exports);
88
+ __exportStar(require("./portalsControllerListParams"), exports);
85
89
  __exportStar(require("./projectAppsControllerListParams"), exports);
86
90
  __exportStar(require("./requestMagicLinkDto"), exports);
87
91
  __exportStar(require("./requestMagicLinkResultDto"), exports);
@@ -89,7 +93,9 @@ __exportStar(require("./requestMagicLinkResultDtoDataEnvelope"), exports);
89
93
  __exportStar(require("./resourceManagedBy"), exports);
90
94
  __exportStar(require("./resourceVisibilityPattern"), exports);
91
95
  __exportStar(require("./subjectKind"), exports);
96
+ __exportStar(require("./surfaceKind"), exports);
92
97
  __exportStar(require("./tokenClass"), exports);
98
+ __exportStar(require("./unarchivePortalDto"), exports);
93
99
  __exportStar(require("./updateAudiencePolicyDto"), exports);
94
100
  __exportStar(require("./updateAudiencePolicyDtoRateLimitPerHourPerSubject"), exports);
95
101
  __exportStar(require("./updatePortalDto"), exports);
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Generated by @xemahq/api-client-generator — do not edit manually.
3
+ * App Runtime API
4
+ * OpenAPI spec version: 0.1.2
5
+ */
6
+ import type { InstallPortalBiomeDtoConfiguration } from './installPortalBiomeDtoConfiguration.js';
7
+ export interface InstallPortalBiomeDto {
8
+ /** Canonical XemaObjectRef for the biome (e.g. `xema://system/biome/document-buddy`). */
9
+ biomeRef: string;
10
+ /** Semver-range string (`^1.2.0`, `~1.2.0`, `1.2.0`, `latest-compatible`). */
11
+ versionConstraint: string;
12
+ /** Free-form per-install configuration the biome consumes. */
13
+ configuration?: InstallPortalBiomeDtoConfiguration;
14
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -4,9 +4,8 @@
4
4
  * OpenAPI spec version: 0.1.2
5
5
  */
6
6
  /**
7
- * Project id. Null or absent for org-scoped portals.
8
- * @nullable
7
+ * Free-form per-install configuration the biome consumes.
9
8
  */
10
- export type CreateProjectAppDtoProjectId = {
9
+ export type InstallPortalBiomeDtoConfiguration = {
11
10
  [key: string]: unknown;
12
- } | null;
11
+ };
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Generated by @xemahq/api-client-generator — do not edit manually.
3
+ * App Runtime API
4
+ * OpenAPI spec version: 0.1.2
5
+ */
6
+ export interface PaginationMeta {
7
+ total?: number;
8
+ page?: number;
9
+ totalPages?: number;
10
+ /** @nullable */
11
+ nextCursor?: string | null;
12
+ /** @nullable */
13
+ previousCursor?: string | null;
14
+ limit?: number;
15
+ hasMore?: boolean;
16
+ }
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ /**
3
+ * Generated by @xemahq/api-client-generator — do not edit manually.
4
+ * App Runtime API
5
+ * OpenAPI spec version: 0.1.2
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -7,5 +7,8 @@ import type { AppDto } from './appDto.js';
7
7
  import type { PortalAccessDto } from './portalAccessDto.js';
8
8
  export interface PortalDetailDto {
9
9
  portal: AppDto;
10
+ /** The portal access this read RESOLVED. When `registered` is false this is the org-shared default the read just repaired the record to, not a record that was found. */
10
11
  access: PortalAccessDto;
12
+ /** Whether the PDP held an access record for this portal BEFORE this read. False means it did not — the portal was invisible to every non-admin member, and this read has registered the org-shared default to repair it. Surfaced rather than hidden because substituting the default and saying nothing rendered "shared with the whole organization" for a portal `listVisible` returned for nobody: a claim the product itself contradicted, with no way for an admin to tell. */
13
+ registered: boolean;
11
14
  }
@@ -0,0 +1,18 @@
1
+ /**
2
+ * Generated by @xemahq/api-client-generator — do not edit manually.
3
+ * App Runtime API
4
+ * OpenAPI spec version: 0.1.2
5
+ */
6
+ export type PortalsControllerListParams = {
7
+ /**
8
+ * Page number (1-indexed)
9
+ * @minimum 1
10
+ */
11
+ page?: number;
12
+ /**
13
+ * Items per page
14
+ * @minimum 1
15
+ * @maximum 100
16
+ */
17
+ limit?: number;
18
+ };
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ /**
3
+ * Generated by @xemahq/api-client-generator — do not edit manually.
4
+ * App Runtime API
5
+ * OpenAPI spec version: 0.1.2
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -9,4 +9,8 @@ export type ProjectAppsControllerListParams = {
9
9
  */
10
10
  projectId?: string;
11
11
  slug?: string;
12
+ /**
13
+ * Include archived Apps. Default false — an archived App no longer accepts sessions (public ingress and every external-auth flow refuse it), so it is out of the listing unless explicitly asked for.
14
+ */
15
+ includeArchived?: boolean;
12
16
  };
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Generated by @xemahq/api-client-generator — do not edit manually.
3
+ * App Runtime API
4
+ * OpenAPI spec version: 0.1.2
5
+ */
6
+ /**
7
+ * 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.
8
+ */
9
+ export type SurfaceKind = typeof SurfaceKind[keyof typeof SurfaceKind];
10
+ export declare const SurfaceKind: {
11
+ readonly declared: "declared";
12
+ readonly composed: "composed";
13
+ readonly coded: "coded";
14
+ };
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+ /**
3
+ * Generated by @xemahq/api-client-generator — do not edit manually.
4
+ * App Runtime API
5
+ * OpenAPI spec version: 0.1.2
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.SurfaceKind = void 0;
9
+ exports.SurfaceKind = {
10
+ declared: 'declared',
11
+ composed: 'composed',
12
+ coded: 'coded',
13
+ };
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Generated by @xemahq/api-client-generator — do not edit manually.
3
+ * App Runtime API
4
+ * OpenAPI spec version: 0.1.2
5
+ */
6
+ import type { PortalAccessDto } from './portalAccessDto.js';
7
+ export interface UnarchivePortalDto {
8
+ access?: PortalAccessDto;
9
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -3,21 +3,13 @@
3
3
  * App Runtime API
4
4
  * OpenAPI spec version: 0.1.2
5
5
  */
6
- import type { AppLockfileDto } from './appLockfileDto.js';
7
- import type { BiomeInstallDto } from './biomeInstallDto.js';
8
6
  import type { BrandingConfigDto } from './brandingConfigDto.js';
9
- import type { CapabilityPolicyOverrideDto } from './capabilityPolicyOverrideDto.js';
10
7
  import type { PortalAccessDto } from './portalAccessDto.js';
11
8
  export interface UpdatePortalDto {
12
9
  displayName?: string;
13
10
  defaultZone?: string;
14
11
  branding?: BrandingConfigDto;
15
- lockfile?: AppLockfileDto;
16
- installedBiomes?: BiomeInstallDto[];
17
- capabilityPolicy?: CapabilityPolicyOverrideDto[];
18
- /** @nullable */
19
- subdomain?: string | null;
12
+ /** 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. */
20
13
  subdomainEnabled?: boolean;
21
- defaultAudience?: string;
22
14
  access?: PortalAccessDto;
23
15
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xemahq/app-platform-api-client",
3
- "version": "0.3.5",
3
+ "version": "0.3.11",
4
4
  "publishConfig": {
5
5
  "access": "public",
6
6
  "registry": "https://registry.npmjs.org/"