@xemahq/app-platform-api-client 0.3.20 → 0.3.21

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, AppDtoPaginatedEnvelope, AppReleaseActionDto, AppReleaseDtoDataEnvelope, AppReleaseHistoryDtoDataArrayEnvelope, AudiencePolicyDtoDataArrayEnvelope, AudiencePolicyDtoDataEnvelope, CreateAppClientDto, CreateAudiencePolicyDto, CreatePortalDto, CreatePortalLaunchEntryDto, CreateProjectAppDto, CreatedAppClientDtoDataEnvelope, InstallPortalBiomeDto, PortalDetailDtoDataEnvelope, PortalLaunchEntriesControllerRemoveParams, PortalLaunchEntryDtoDataArrayEnvelope, PortalLaunchEntryDtoDataEnvelope, PortalsControllerListParams, ProjectAppsControllerListParams, RescopePortalDto, ResolvedPortalLaunchDtoDataEnvelope, UnarchivePortalDto, UpdateAudiencePolicyDto, UpdatePortalDto, UpdatePortalLaunchEntryDto } from '../../models';
6
+ import type { AppClientDtoDataArrayEnvelope, AppClientDtoDataEnvelope, AppDtoDataArrayEnvelope, AppDtoDataEnvelope, AppDtoPaginatedEnvelope, AppReleaseActionDto, AppReleaseDtoDataEnvelope, AppReleaseHistoryDtoDataArrayEnvelope, AudiencePolicyDtoDataArrayEnvelope, AudiencePolicyDtoDataEnvelope, CreateAppClientDto, CreateAudiencePolicyDto, CreatePortalDto, CreatePortalLaunchEntryDto, CreateProjectAppDto, CreatedAppClientDtoDataEnvelope, InstallPortalBiomeDto, PortalDetailDtoDataEnvelope, PortalLaunchEntriesControllerRemoveParams, PortalLaunchEntryDtoDataArrayEnvelope, PortalLaunchEntryDtoDataEnvelope, PortalPromotionPreviewDtoDataEnvelope, PortalsControllerListParams, ProjectAppsControllerListParams, RescopePortalDto, ResolvedPortalLaunchDtoDataEnvelope, UnarchivePortalDto, UpdateAudiencePolicyDto, UpdatePortalDto, UpdatePortalLaunchEntryDto } from '../../models';
7
7
  export declare const getProjectAppsControllerCreateUrl: () => string;
8
8
  /**
9
9
  * @summary Create an App in the caller org + named project.
@@ -109,6 +109,11 @@ export declare const getPortalsControllerReadoptUrl: (id: string) => string;
109
109
  * @summary Hand a UI-adopted default portal back to the reconciler (portal-admin only), so it resumes tracking the installed web biomes.
110
110
  */
111
111
  export declare const portalsControllerReadopt: (id: string, options?: RequestInit) => Promise<AppDtoDataEnvelope>;
112
+ export declare const getPortalsControllerPromotionPreviewUrl: (id: string) => string;
113
+ /**
114
+ * @summary READ-ONLY: what WOULD happen if this portal were promoted to the organisation. Reports every reason it would be refused — ownership, org role, an illegal tier move, and the organisation's own growth gate — rather than only the first, and never performs the promotion. Same authority as seeing the portal; it reports no fact about the portal a viewer could not already read. An unreachable policy authority is reported as UNKNOWN, never as permitted.
115
+ */
116
+ export declare const portalsControllerPromotionPreview: (id: string, options?: RequestInit) => Promise<PortalPromotionPreviewDtoDataEnvelope>;
112
117
  export declare const getPortalsControllerRescopeUrl: (id: string) => string;
113
118
  /**
114
119
  * @summary Promote a PERSONAL portal to organisation ownership — "share this with my organisation". Only the owner may release it (an org admin cannot publish somebody else's), and only `org` is a legal target. A demotion or a same-tier move is 422; a portal you may not see is 404.
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.portalsControllerRefreshLockfile = exports.getPortalsControllerRefreshLockfileUrl = exports.portalsControllerUninstallBiome = exports.getPortalsControllerUninstallBiomeUrl = exports.portalsControllerInstallBiome = exports.getPortalsControllerInstallBiomeUrl = exports.portalsControllerRescope = exports.getPortalsControllerRescopeUrl = 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
- exports.portalLaunchEntriesControllerResolve = exports.getPortalLaunchEntriesControllerResolveUrl = exports.portalLaunchEntriesControllerRemove = exports.getPortalLaunchEntriesControllerRemoveUrl = exports.portalLaunchEntriesControllerUpdate = exports.getPortalLaunchEntriesControllerUpdateUrl = exports.portalLaunchEntriesControllerCreate = exports.getPortalLaunchEntriesControllerCreateUrl = exports.portalLaunchEntriesControllerList = exports.getPortalLaunchEntriesControllerListUrl = void 0;
3
+ exports.portalsControllerUninstallBiome = exports.getPortalsControllerUninstallBiomeUrl = exports.portalsControllerInstallBiome = exports.getPortalsControllerInstallBiomeUrl = exports.portalsControllerRescope = exports.getPortalsControllerRescopeUrl = exports.portalsControllerPromotionPreview = exports.getPortalsControllerPromotionPreviewUrl = 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
+ exports.portalLaunchEntriesControllerResolve = exports.getPortalLaunchEntriesControllerResolveUrl = exports.portalLaunchEntriesControllerRemove = exports.getPortalLaunchEntriesControllerRemoveUrl = exports.portalLaunchEntriesControllerUpdate = exports.getPortalLaunchEntriesControllerUpdateUrl = exports.portalLaunchEntriesControllerCreate = exports.getPortalLaunchEntriesControllerCreateUrl = exports.portalLaunchEntriesControllerList = exports.getPortalLaunchEntriesControllerListUrl = exports.portalsControllerRefreshLockfile = exports.getPortalsControllerRefreshLockfileUrl = void 0;
5
5
  const custom_fetch_1 = require("../../custom-fetch");
6
6
  const getProjectAppsControllerCreateUrl = () => {
7
7
  return `/bff/apps`;
@@ -351,6 +351,20 @@ const portalsControllerReadopt = async (id, options) => {
351
351
  });
352
352
  };
353
353
  exports.portalsControllerReadopt = portalsControllerReadopt;
354
+ const getPortalsControllerPromotionPreviewUrl = (id) => {
355
+ return `/bff/portals/${id}/promotion-preview`;
356
+ };
357
+ exports.getPortalsControllerPromotionPreviewUrl = getPortalsControllerPromotionPreviewUrl;
358
+ /**
359
+ * @summary READ-ONLY: what WOULD happen if this portal were promoted to the organisation. Reports every reason it would be refused — ownership, org role, an illegal tier move, and the organisation's own growth gate — rather than only the first, and never performs the promotion. Same authority as seeing the portal; it reports no fact about the portal a viewer could not already read. An unreachable policy authority is reported as UNKNOWN, never as permitted.
360
+ */
361
+ const portalsControllerPromotionPreview = async (id, options) => {
362
+ return (0, custom_fetch_1.customFetch)((0, exports.getPortalsControllerPromotionPreviewUrl)(id), {
363
+ ...options,
364
+ method: 'GET'
365
+ });
366
+ };
367
+ exports.portalsControllerPromotionPreview = portalsControllerPromotionPreview;
354
368
  const getPortalsControllerRescopeUrl = (id) => {
355
369
  return `/bff/portals/${id}/rescope`;
356
370
  };
@@ -85,6 +85,11 @@ export * from './portalLaunchEntryDto';
85
85
  export * from './portalLaunchEntryDtoDataArrayEnvelope';
86
86
  export * from './portalLaunchEntryDtoDataEnvelope';
87
87
  export * from './portalLaunchPresentationDto';
88
+ export * from './portalPromotionGovernanceDto';
89
+ export * from './portalPromotionPreviewDto';
90
+ export * from './portalPromotionPreviewDtoDataEnvelope';
91
+ export * from './portalPromotionRefusalDto';
92
+ export * from './portalPromotionRefusalReason';
88
93
  export * from './portalShareDto';
89
94
  export * from './portalsControllerListParams';
90
95
  export * from './projectAppsControllerListParams';
@@ -101,6 +106,7 @@ export * from './resolvedPortalLaunchDtoDataEnvelope';
101
106
  export * from './resourceManagedBy';
102
107
  export * from './resourceVisibilityPattern';
103
108
  export * from './revisionTargetDto';
109
+ export * from './spaceKind';
104
110
  export * from './subjectKind';
105
111
  export * from './surfaceKind';
106
112
  export * from './tokenClass';
@@ -102,6 +102,11 @@ __exportStar(require("./portalLaunchEntryDto"), exports);
102
102
  __exportStar(require("./portalLaunchEntryDtoDataArrayEnvelope"), exports);
103
103
  __exportStar(require("./portalLaunchEntryDtoDataEnvelope"), exports);
104
104
  __exportStar(require("./portalLaunchPresentationDto"), exports);
105
+ __exportStar(require("./portalPromotionGovernanceDto"), exports);
106
+ __exportStar(require("./portalPromotionPreviewDto"), exports);
107
+ __exportStar(require("./portalPromotionPreviewDtoDataEnvelope"), exports);
108
+ __exportStar(require("./portalPromotionRefusalDto"), exports);
109
+ __exportStar(require("./portalPromotionRefusalReason"), exports);
105
110
  __exportStar(require("./portalShareDto"), exports);
106
111
  __exportStar(require("./portalsControllerListParams"), exports);
107
112
  __exportStar(require("./projectAppsControllerListParams"), exports);
@@ -118,6 +123,7 @@ __exportStar(require("./resolvedPortalLaunchDtoDataEnvelope"), exports);
118
123
  __exportStar(require("./resourceManagedBy"), exports);
119
124
  __exportStar(require("./resourceVisibilityPattern"), exports);
120
125
  __exportStar(require("./revisionTargetDto"), exports);
126
+ __exportStar(require("./spaceKind"), exports);
121
127
  __exportStar(require("./subjectKind"), exports);
122
128
  __exportStar(require("./surfaceKind"), exports);
123
129
  __exportStar(require("./tokenClass"), exports);
@@ -0,0 +1,13 @@
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 PortalPromotionGovernanceDto {
7
+ /** Whether the organisation growth policy could be READ. False means the authority was unreachable — distinct from a refusal, because a refusal is final and an outage is transient, and a UI must not present one as the other. */
8
+ known: boolean;
9
+ /** Whether the organisation's growth gate permits this promotion. Meaningless unless `known` is true; an unreachable authority is never reported as permitted. */
10
+ allowed: boolean;
11
+ /** @nullable */
12
+ detail: string | null;
13
+ }
@@ -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 });
@@ -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
+ import type { PortalPromotionGovernanceDto } from './portalPromotionGovernanceDto.js';
7
+ import type { PortalPromotionRefusalDto } from './portalPromotionRefusalDto.js';
8
+ import type { SpaceKind } from './spaceKind.js';
9
+ export interface PortalPromotionPreviewDto {
10
+ currentTier: SpaceKind;
11
+ /** The only legal promotion target for a portal today: `org`. */
12
+ target: SpaceKind;
13
+ /** True only when EVERY check passed and the growth gate was reachable. An unknown gate is not an allowance. */
14
+ allowed: boolean;
15
+ /** EVERY reason it would be refused, not just the first. The write path short-circuits, which is right for a write and wrong for a preview — fixing one blocker at a time is three round trips through a human. */
16
+ refusals: PortalPromotionRefusalDto[];
17
+ governance: PortalPromotionGovernanceDto;
18
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -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 { PortalPromotionPreviewDto } from './portalPromotionPreviewDto.js';
7
+ export interface PortalPromotionPreviewDtoDataEnvelope {
8
+ data: PortalPromotionPreviewDto;
9
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,12 @@
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 { PortalPromotionRefusalReason } from './portalPromotionRefusalReason.js';
7
+ export interface PortalPromotionRefusalDto {
8
+ /** Which check refused. A CLOSED set, so a renderer can map each to its own remedy instead of printing a message it did not expect. */
9
+ reason: PortalPromotionRefusalReason;
10
+ /** The refusing check's own message, verbatim. */
11
+ detail: string;
12
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -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
+ /**
7
+ * Which check refused. A CLOSED set, so a renderer can map each to its own remedy instead of printing a message it did not expect.
8
+ */
9
+ export type PortalPromotionRefusalReason = typeof PortalPromotionRefusalReason[keyof typeof PortalPromotionRefusalReason];
10
+ export declare const PortalPromotionRefusalReason: {
11
+ readonly 'target-unsupported': "target-unsupported";
12
+ readonly 'not-the-owner': "not-the-owner";
13
+ readonly 'org-role': "org-role";
14
+ readonly 'illegal-promotion': "illegal-promotion";
15
+ readonly 'org-growth-gate': "org-growth-gate";
16
+ };
@@ -0,0 +1,15 @@
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.PortalPromotionRefusalReason = void 0;
9
+ exports.PortalPromotionRefusalReason = {
10
+ 'target-unsupported': 'target-unsupported',
11
+ 'not-the-owner': 'not-the-owner',
12
+ 'org-role': 'org-role',
13
+ 'illegal-promotion': 'illegal-promotion',
14
+ 'org-growth-gate': 'org-growth-gate',
15
+ };
@@ -0,0 +1,15 @@
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 SpaceKind = typeof SpaceKind[keyof typeof SpaceKind];
7
+ export declare const SpaceKind: {
8
+ readonly system: "system";
9
+ readonly org: "org";
10
+ readonly project: "project";
11
+ readonly app: "app";
12
+ readonly session: "session";
13
+ readonly biome: "biome";
14
+ readonly user: "user";
15
+ };
@@ -0,0 +1,17 @@
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.SpaceKind = void 0;
9
+ exports.SpaceKind = {
10
+ system: 'system',
11
+ org: 'org',
12
+ project: 'project',
13
+ app: 'app',
14
+ session: 'session',
15
+ biome: 'biome',
16
+ user: 'user',
17
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xemahq/app-platform-api-client",
3
- "version": "0.3.20",
3
+ "version": "0.3.21",
4
4
  "publishConfig": {
5
5
  "access": "public",
6
6
  "registry": "https://registry.npmjs.org/"