@xemahq/app-platform-api-client 0.3.19 → 0.3.20
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.
- package/dist/endpoints/project-apps/project-apps.d.ts +7 -2
- package/dist/endpoints/project-apps/project-apps.js +19 -3
- package/dist/models/appDto.d.ts +2 -0
- package/dist/models/createPortalDto.d.ts +2 -0
- package/dist/models/createProjectAppDto.d.ts +2 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/rescopePortalDto.d.ts +10 -0
- package/dist/models/rescopePortalDto.js +2 -0
- package/dist/models/rescopePortalTargetDto.d.ts +10 -0
- package/dist/models/rescopePortalTargetDto.js +2 -0
- package/dist/models/rescopePortalTargetDtoTier.d.ts +12 -0
- package/dist/models/rescopePortalTargetDtoTier.js +11 -0
- package/package.json +2 -2
|
@@ -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, 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, 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.
|
|
@@ -76,7 +76,7 @@ export declare const getPortalsControllerListUrl: (params?: PortalsControllerLis
|
|
|
76
76
|
export declare const portalsControllerList: (params?: PortalsControllerListParams, options?: RequestInit) => Promise<AppDtoPaginatedEnvelope>;
|
|
77
77
|
export declare const getPortalsControllerCreateUrl: () => string;
|
|
78
78
|
/**
|
|
79
|
-
* @summary Create an
|
|
79
|
+
* @summary Create a portal. Omit `ownerSpaceUri` for an ORGANISATION portal (portal-admin only); pass your own `xema://users/<id>` for a PERSONAL portal, which any member may create and which nobody else can see until it is promoted.
|
|
80
80
|
*/
|
|
81
81
|
export declare const portalsControllerCreate: (createPortalDto: CreatePortalDto, options?: RequestInit) => Promise<AppDtoDataEnvelope>;
|
|
82
82
|
export declare const getPortalsControllerGetOneUrl: (id: string) => string;
|
|
@@ -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 getPortalsControllerRescopeUrl: (id: string) => string;
|
|
113
|
+
/**
|
|
114
|
+
* @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.
|
|
115
|
+
*/
|
|
116
|
+
export declare const portalsControllerRescope: (id: string, rescopePortalDto: RescopePortalDto, options?: RequestInit) => Promise<AppDtoDataEnvelope>;
|
|
112
117
|
export declare const getPortalsControllerInstallBiomeUrl: (id: string) => string;
|
|
113
118
|
/**
|
|
114
119
|
* @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.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
4
|
-
exports.portalLaunchEntriesControllerResolve = exports.getPortalLaunchEntriesControllerResolveUrl = exports.portalLaunchEntriesControllerRemove = exports.getPortalLaunchEntriesControllerRemoveUrl = exports.portalLaunchEntriesControllerUpdate = exports.getPortalLaunchEntriesControllerUpdateUrl = exports.portalLaunchEntriesControllerCreate = exports.getPortalLaunchEntriesControllerCreateUrl = void 0;
|
|
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;
|
|
5
5
|
const custom_fetch_1 = require("../../custom-fetch");
|
|
6
6
|
const getProjectAppsControllerCreateUrl = () => {
|
|
7
7
|
return `/bff/apps`;
|
|
@@ -252,7 +252,7 @@ const getPortalsControllerCreateUrl = () => {
|
|
|
252
252
|
};
|
|
253
253
|
exports.getPortalsControllerCreateUrl = getPortalsControllerCreateUrl;
|
|
254
254
|
/**
|
|
255
|
-
* @summary Create an
|
|
255
|
+
* @summary Create a portal. Omit `ownerSpaceUri` for an ORGANISATION portal (portal-admin only); pass your own `xema://users/<id>` for a PERSONAL portal, which any member may create and which nobody else can see until it is promoted.
|
|
256
256
|
*/
|
|
257
257
|
const portalsControllerCreate = async (createPortalDto, options) => {
|
|
258
258
|
return (0, custom_fetch_1.customFetch)((0, exports.getPortalsControllerCreateUrl)(), {
|
|
@@ -351,6 +351,22 @@ const portalsControllerReadopt = async (id, options) => {
|
|
|
351
351
|
});
|
|
352
352
|
};
|
|
353
353
|
exports.portalsControllerReadopt = portalsControllerReadopt;
|
|
354
|
+
const getPortalsControllerRescopeUrl = (id) => {
|
|
355
|
+
return `/bff/portals/${id}/rescope`;
|
|
356
|
+
};
|
|
357
|
+
exports.getPortalsControllerRescopeUrl = getPortalsControllerRescopeUrl;
|
|
358
|
+
/**
|
|
359
|
+
* @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.
|
|
360
|
+
*/
|
|
361
|
+
const portalsControllerRescope = async (id, rescopePortalDto, options) => {
|
|
362
|
+
return (0, custom_fetch_1.customFetch)((0, exports.getPortalsControllerRescopeUrl)(id), {
|
|
363
|
+
...options,
|
|
364
|
+
method: 'POST',
|
|
365
|
+
headers: { 'Content-Type': 'application/json', ...options?.headers },
|
|
366
|
+
body: JSON.stringify(rescopePortalDto)
|
|
367
|
+
});
|
|
368
|
+
};
|
|
369
|
+
exports.portalsControllerRescope = portalsControllerRescope;
|
|
354
370
|
const getPortalsControllerInstallBiomeUrl = (id) => {
|
|
355
371
|
return `/bff/portals/${id}/biomes`;
|
|
356
372
|
};
|
package/dist/models/appDto.d.ts
CHANGED
|
@@ -15,6 +15,8 @@ export interface AppDto {
|
|
|
15
15
|
orgId: string;
|
|
16
16
|
/** @nullable */
|
|
17
17
|
projectId: string | null;
|
|
18
|
+
/** Canonical `xema://…` Space URI of the owner. TOTAL — every portal states its owner, and an org-owned portal reads `xema://orgs/<orgId>` rather than an absence, so one fact has exactly one representation. A PERSONAL portal is `xema://users/<id>`; it is visible to its owner by ownership and to nobody else until promoted via `POST /bff/portals/:id/rescope`. Ask THIS field, never `projectId`: an org-owned portal and a personal one both carry `projectId === null`. */
|
|
19
|
+
ownerSpaceUri: string;
|
|
18
20
|
/** Canonical XemaObjectRef computed from (orgId, projectId, App, slug). */
|
|
19
21
|
ref: string;
|
|
20
22
|
displayName: string;
|
|
@@ -12,6 +12,8 @@ import type { PortalAccessDto } from './portalAccessDto.js';
|
|
|
12
12
|
export interface CreatePortalDto {
|
|
13
13
|
/** Stable slug unique within (orgId, projectId) for project apps, or (orgId) for portals. */
|
|
14
14
|
slug: string;
|
|
15
|
+
/** Canonical `xema://…` Space URI of the owner, when it is anything other than the organisation. OMITTED means the organisation owns it — an answer, not a gap, and the state every existing portal is in. A personal portal is `xema://users/<id>`. Refused (422) if the address does not parse or names a tier the `portal` resource kind does not admit; never silently defaulted to the organisation, which would be the widest possible reading of a malformed request. */
|
|
16
|
+
ownerSpaceUri?: string;
|
|
15
17
|
displayName: string;
|
|
16
18
|
/** Default ExecutionEnvironment slug (e.g. `public-session`). */
|
|
17
19
|
defaultZone: string;
|
|
@@ -12,6 +12,8 @@ import type { SurfaceKind } from './surfaceKind.js';
|
|
|
12
12
|
export interface CreateProjectAppDto {
|
|
13
13
|
/** Stable slug unique within (orgId, projectId) for project apps, or (orgId) for portals. */
|
|
14
14
|
slug: string;
|
|
15
|
+
/** Canonical `xema://…` Space URI of the owner, when it is anything other than the organisation. OMITTED means the organisation owns it — an answer, not a gap, and the state every existing portal is in. A personal portal is `xema://users/<id>`. Refused (422) if the address does not parse or names a tier the `portal` resource kind does not admit; never silently defaulted to the organisation, which would be the widest possible reading of a malformed request. */
|
|
16
|
+
ownerSpaceUri?: string;
|
|
15
17
|
/**
|
|
16
18
|
* Project id. Null or absent for org-scoped portals.
|
|
17
19
|
* @nullable
|
package/dist/models/index.d.ts
CHANGED
|
@@ -93,6 +93,9 @@ export * from './releaseChannelRevisionSelectorDtoKind';
|
|
|
93
93
|
export * from './requestMagicLinkDto';
|
|
94
94
|
export * from './requestMagicLinkResultDto';
|
|
95
95
|
export * from './requestMagicLinkResultDtoDataEnvelope';
|
|
96
|
+
export * from './rescopePortalDto';
|
|
97
|
+
export * from './rescopePortalTargetDto';
|
|
98
|
+
export * from './rescopePortalTargetDtoTier';
|
|
96
99
|
export * from './resolvedPortalLaunchDto';
|
|
97
100
|
export * from './resolvedPortalLaunchDtoDataEnvelope';
|
|
98
101
|
export * from './resourceManagedBy';
|
package/dist/models/index.js
CHANGED
|
@@ -110,6 +110,9 @@ __exportStar(require("./releaseChannelRevisionSelectorDtoKind"), exports);
|
|
|
110
110
|
__exportStar(require("./requestMagicLinkDto"), exports);
|
|
111
111
|
__exportStar(require("./requestMagicLinkResultDto"), exports);
|
|
112
112
|
__exportStar(require("./requestMagicLinkResultDtoDataEnvelope"), exports);
|
|
113
|
+
__exportStar(require("./rescopePortalDto"), exports);
|
|
114
|
+
__exportStar(require("./rescopePortalTargetDto"), exports);
|
|
115
|
+
__exportStar(require("./rescopePortalTargetDtoTier"), exports);
|
|
113
116
|
__exportStar(require("./resolvedPortalLaunchDto"), exports);
|
|
114
117
|
__exportStar(require("./resolvedPortalLaunchDtoDataEnvelope"), exports);
|
|
115
118
|
__exportStar(require("./resourceManagedBy"), exports);
|
|
@@ -0,0 +1,10 @@
|
|
|
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 { RescopePortalTargetDto } from './rescopePortalTargetDto.js';
|
|
7
|
+
export interface RescopePortalDto {
|
|
8
|
+
/** The Space to promote this portal into. Promotion only ever BROADENS the audience; a demotion or a same-tier move is refused with 422. */
|
|
9
|
+
toSpace: RescopePortalTargetDto;
|
|
10
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
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 { RescopePortalTargetDtoTier } from './rescopePortalTargetDtoTier.js';
|
|
7
|
+
export interface RescopePortalTargetDto {
|
|
8
|
+
/** Owning tier to promote this portal INTO. Only `org` is accepted: promotion only ever broadens, and a portal has no project-owner tier because `projectId` already is its project axis. */
|
|
9
|
+
tier: RescopePortalTargetDtoTier;
|
|
10
|
+
}
|
|
@@ -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
|
+
/**
|
|
7
|
+
* Owning tier to promote this portal INTO. Only `org` is accepted: promotion only ever broadens, and a portal has no project-owner tier because `projectId` already is its project axis.
|
|
8
|
+
*/
|
|
9
|
+
export type RescopePortalTargetDtoTier = typeof RescopePortalTargetDtoTier[keyof typeof RescopePortalTargetDtoTier];
|
|
10
|
+
export declare const RescopePortalTargetDtoTier: {
|
|
11
|
+
readonly org: "org";
|
|
12
|
+
};
|
|
@@ -0,0 +1,11 @@
|
|
|
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.RescopePortalTargetDtoTier = void 0;
|
|
9
|
+
exports.RescopePortalTargetDtoTier = {
|
|
10
|
+
org: 'org',
|
|
11
|
+
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xemahq/app-platform-api-client",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.20",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public",
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
"service": "app-platform-api",
|
|
21
21
|
"biome": "app-platform",
|
|
22
22
|
"target": "server",
|
|
23
|
-
"generator": "@xemahq/api-client-generator@0.15.
|
|
23
|
+
"generator": "@xemahq/api-client-generator@0.15.2",
|
|
24
24
|
"source": "openapi.public.json"
|
|
25
25
|
},
|
|
26
26
|
"license": "LicenseRef-Xema-BSL-1.1",
|