@xemahq/app-platform-internal-api-client 0.3.9 → 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.
|
@@ -11,7 +11,7 @@ export declare const getAppsControllerCreateUrl: () => string;
|
|
|
11
11
|
export declare const appsControllerCreate: (createAppDto: CreateAppDto, options?: RequestInit) => Promise<AppDtoDataEnvelope>;
|
|
12
12
|
export declare const getAppsControllerListUrl: (params?: AppsControllerListParams) => string;
|
|
13
13
|
/**
|
|
14
|
-
* @summary List Apps (filtered by orgId, projectId, portalOnly, and/or slug).
|
|
14
|
+
* @summary List Apps (filtered by orgId, projectId, portalOnly, and/or slug). Archived Apps are excluded unless `includeArchived=true`.
|
|
15
15
|
*/
|
|
16
16
|
export declare const appsControllerList: (params?: AppsControllerListParams, options?: RequestInit) => Promise<AppDtoDataArrayEnvelope>;
|
|
17
17
|
export declare const getAppsControllerGetByIdUrl: (id: string) => string;
|
|
@@ -42,7 +42,7 @@ const getAppsControllerListUrl = (params) => {
|
|
|
42
42
|
};
|
|
43
43
|
exports.getAppsControllerListUrl = getAppsControllerListUrl;
|
|
44
44
|
/**
|
|
45
|
-
* @summary List Apps (filtered by orgId, projectId, portalOnly, and/or slug).
|
|
45
|
+
* @summary List Apps (filtered by orgId, projectId, portalOnly, and/or slug). Archived Apps are excluded unless `includeArchived=true`.
|
|
46
46
|
*/
|
|
47
47
|
const appsControllerList = async (params, options) => {
|
|
48
48
|
return (0, custom_fetch_1.customFetch)((0, exports.getAppsControllerListUrl)(params), {
|
package/dist/models/appDto.d.ts
CHANGED
|
@@ -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
|
-
/**
|
|
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:
|
|
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
|
}
|
|
@@ -7,5 +7,12 @@ export type AppsControllerListParams = {
|
|
|
7
7
|
orgId?: string;
|
|
8
8
|
projectId?: string;
|
|
9
9
|
slug?: string;
|
|
10
|
+
/**
|
|
11
|
+
* Restrict to ORG-scoped Apps (projectId IS NULL).
|
|
12
|
+
*/
|
|
10
13
|
portalOnly?: boolean;
|
|
14
|
+
/**
|
|
15
|
+
* 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.
|
|
16
|
+
*/
|
|
17
|
+
includeArchived?: boolean;
|
|
11
18
|
};
|
|
@@ -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';
|
|
@@ -24,10 +25,9 @@ export interface CreateAppDto {
|
|
|
24
25
|
lockfile: AppLockfileDto;
|
|
25
26
|
installedBiomes: BiomeInstallDto[];
|
|
26
27
|
capabilityPolicy: CapabilityPolicyOverrideDto[];
|
|
27
|
-
/**
|
|
28
|
-
subdomain?: string | null;
|
|
28
|
+
/** 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. */
|
|
29
29
|
subdomainEnabled?: boolean;
|
|
30
|
-
defaultAudience?:
|
|
30
|
+
defaultAudience?: AudienceKind;
|
|
31
31
|
archived?: boolean;
|
|
32
32
|
/** 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. */
|
|
33
33
|
surface?: SurfaceKind;
|
|
@@ -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';
|
|
@@ -14,8 +15,7 @@ export interface UpdateAppDto {
|
|
|
14
15
|
lockfile?: AppLockfileDto;
|
|
15
16
|
installedBiomes?: BiomeInstallDto[];
|
|
16
17
|
capabilityPolicy?: CapabilityPolicyOverrideDto[];
|
|
17
|
-
/**
|
|
18
|
-
subdomain?: string | null;
|
|
18
|
+
/** 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. */
|
|
19
19
|
subdomainEnabled?: boolean;
|
|
20
|
-
defaultAudience?:
|
|
20
|
+
defaultAudience?: AudienceKind;
|
|
21
21
|
}
|