@xemahq/space-registry-api-client 0.2.10 → 0.2.12

package/dist/endpoints/resource-roles/resource-roles.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * Space Registry API
+ * OpenAPI spec version: 0.1.0
+ */
+import type { ResourceRoleCatalogueResponseDtoDataEnvelope, ResourceRolesCatalogueControllerListParams } from '../../models';
+export declare const getResourceRolesCatalogueControllerListUrl: (params?: ResourceRolesCatalogueControllerListParams) => string;
+/**
+ * The roles a biome (or a system seed) has declared, each with what it is for and the space tiers a consumer resolves it at. Declaring a role and ANSWERING one are different questions: which resource plays a role is the organisation’s, per owner, and is served by `/resource-role-bindings`. An empty list is an answer — nothing has declared a role — never a defaulted catalogue.
+ * @summary Every role DECLARED in this deployment
+ */
+export declare const resourceRolesCatalogueControllerList: (params?: ResourceRolesCatalogueControllerListParams, options?: RequestInit) => Promise<ResourceRoleCatalogueResponseDtoDataEnvelope>;

package/dist/endpoints/resource-roles/resource-roles.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resourceRolesCatalogueControllerList = exports.getResourceRolesCatalogueControllerListUrl = void 0;
+const custom_fetch_1 = require("../../custom-fetch");
+const getResourceRolesCatalogueControllerListUrl = (params) => {
+    const normalizedParams = new URLSearchParams();
+    Object.entries(params || {}).forEach(([key, value]) => {
+        if (value === undefined)
+            return;
+        if (value === null) {
+            normalizedParams.append(key, 'null');
+            return;
+        }
+        if (Array.isArray(value)) {
+            for (const item of value) {
+                if (item === undefined || item === null)
+                    continue;
+                normalizedParams.append(key, item.toString());
+            }
+            return;
+        }
+        normalizedParams.append(key, value.toString());
+    });
+    const stringifiedParams = normalizedParams.toString();
+    return stringifiedParams.length > 0 ? `/resource-roles?${stringifiedParams}` : `/resource-roles`;
+};
+exports.getResourceRolesCatalogueControllerListUrl = getResourceRolesCatalogueControllerListUrl;
+/**
+ * The roles a biome (or a system seed) has declared, each with what it is for and the space tiers a consumer resolves it at. Declaring a role and ANSWERING one are different questions: which resource plays a role is the organisation’s, per owner, and is served by `/resource-role-bindings`. An empty list is an answer — nothing has declared a role — never a defaulted catalogue.
+ * @summary Every role DECLARED in this deployment
+ */
+const resourceRolesCatalogueControllerList = async (params, options) => {
+    return (0, custom_fetch_1.customFetch)((0, exports.getResourceRolesCatalogueControllerListUrl)(params), {
+        ...options,
+        method: 'GET'
+    });
+};
+exports.resourceRolesCatalogueControllerList = resourceRolesCatalogueControllerList;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { configureClient, getClientConfig, ClientError, customFetch, type ClientConfig, type RetryNotice } from './custom-fetch';
 export * from './models';
 export * from './endpoints/resource-role-bindings/resource-role-bindings';
+export * from './endpoints/resource-roles/resource-roles';
 export * from './endpoints/spaces/spaces';

package/dist/index.js

@@ -23,4 +23,5 @@ Object.defineProperty(exports, "ClientError", { enumerable: true, get: function
 Object.defineProperty(exports, "customFetch", { enumerable: true, get: function () { return custom_fetch_1.customFetch; } });
 __exportStar(require("./models"), exports);
 __exportStar(require("./endpoints/resource-role-bindings/resource-role-bindings"), exports);
+__exportStar(require("./endpoints/resource-roles/resource-roles"), exports);
 __exportStar(require("./endpoints/spaces/spaces"), exports);

package/dist/models/index.d.ts

@@ -11,7 +11,9 @@ export * from './memberShellModeOverrideDto';
 export * from './memberShellModeOverrideDtoMode';
 export * from './orgExperienceSettingsDto';
 export * from './orgExperienceSettingsDtoDataEnvelope';
+export * from './orgExperienceSettingsDtoEffectiveShellMode';
 export * from './orgExperienceSettingsDtoMemberShellMode';
+export * from './orgExperienceSettingsDtoUnstatedMemberShellMode';
 export * from './orgGovernanceSettingsDto';
 export * from './orgGovernanceSettingsDtoDataEnvelope';
 export * from './orgGrowthSettingsDto';
@@ -23,6 +25,11 @@ export * from './resourceRoleBindingListResponseDtoDataEnvelope';
 export * from './resourceRoleBindingResponseDto';
 export * from './resourceRoleBindingResponseDtoDataEnvelope';
 export * from './resourceRoleBindingResponseDtoTarget';
+export * from './resourceRoleCatalogueResponseDto';
+export * from './resourceRoleCatalogueResponseDtoDataEnvelope';
+export * from './resourceRoleDeclarationResponseDto';
+export * from './resourceRoleDeclarationResponseDtoResolvedAtSpaceKindsItem';
+export * from './resourceRolesCatalogueControllerListParams';
 export * from './resourceRolesControllerListParams';
 export * from './resourceRolesControllerResolveParams';
 export * from './resourceRolesControllerUnsetParams';

package/dist/models/index.js

@@ -28,7 +28,9 @@ __exportStar(require("./memberShellModeOverrideDto"), exports);
 __exportStar(require("./memberShellModeOverrideDtoMode"), exports);
 __exportStar(require("./orgExperienceSettingsDto"), exports);
 __exportStar(require("./orgExperienceSettingsDtoDataEnvelope"), exports);
+__exportStar(require("./orgExperienceSettingsDtoEffectiveShellMode"), exports);
 __exportStar(require("./orgExperienceSettingsDtoMemberShellMode"), exports);
+__exportStar(require("./orgExperienceSettingsDtoUnstatedMemberShellMode"), exports);
 __exportStar(require("./orgGovernanceSettingsDto"), exports);
 __exportStar(require("./orgGovernanceSettingsDtoDataEnvelope"), exports);
 __exportStar(require("./orgGrowthSettingsDto"), exports);
@@ -40,6 +42,11 @@ __exportStar(require("./resourceRoleBindingListResponseDtoDataEnvelope"), export
 __exportStar(require("./resourceRoleBindingResponseDto"), exports);
 __exportStar(require("./resourceRoleBindingResponseDtoDataEnvelope"), exports);
 __exportStar(require("./resourceRoleBindingResponseDtoTarget"), exports);
+__exportStar(require("./resourceRoleCatalogueResponseDto"), exports);
+__exportStar(require("./resourceRoleCatalogueResponseDtoDataEnvelope"), exports);
+__exportStar(require("./resourceRoleDeclarationResponseDto"), exports);
+__exportStar(require("./resourceRoleDeclarationResponseDtoResolvedAtSpaceKindsItem"), exports);
+__exportStar(require("./resourceRolesCatalogueControllerListParams"), exports);
 __exportStar(require("./resourceRolesControllerListParams"), exports);
 __exportStar(require("./resourceRolesControllerResolveParams"), exports);
 __exportStar(require("./resourceRolesControllerUnsetParams"), exports);

package/dist/models/orgExperienceSettingsDto.d.ts

@@ -4,14 +4,20 @@
  * OpenAPI spec version: 0.1.0
  */
 import type { MemberShellModeOverrideDto } from './memberShellModeOverrideDto.js';
+import type { OrgExperienceSettingsDtoEffectiveShellMode } from './orgExperienceSettingsDtoEffectiveShellMode.js';
 import type { OrgExperienceSettingsDtoMemberShellMode } from './orgExperienceSettingsDtoMemberShellMode.js';
+import type { OrgExperienceSettingsDtoUnstatedMemberShellMode } from './orgExperienceSettingsDtoUnstatedMemberShellMode.js';
 export interface OrgExperienceSettingsDto {
     /** False when this organization has never written an experience policy. */
     configured: boolean;
-    /** How the shell presents itself to an ordinary member. Absent = the full shell (today's behaviour). Administrators are never confined. */
+    /** How the shell presents itself to an ordinary member. Absent leaves today's behaviour in place, which is portal-focused for an ordinary member — see `effectiveShellMode`, which is the field a shell should read. Administrators are never confined. */
     memberShellMode?: OrgExperienceSettingsDtoMemberShellMode;
     /** Per-group overrides, evaluated in declaration order so a member of two overridden groups gets a deterministic answer. */
     shellModeOverrides?: MemberShellModeOverrideDto[];
+    /** THE FIELD A SHELL READS: which mode THIS caller is in, with the org-wide setting, the per-group overrides and the caller's role already applied. Always present — there is always an answer, and an unconfigured org resolves to the behaviour it already has. The fields above are the POLICY an administrator edits; a shell that reads them instead would re-implement this resolution and drift from it. Still presentation only: it grants and withholds nothing. */
+    effectiveShellMode: OrgExperienceSettingsDtoEffectiveShellMode;
+    /** What an ordinary member gets when this organization has stated nothing — the platform default, not a value anyone configured. Published because an administrator looking at an unconfigured policy still needs to know what their members see, and the alternative is every consumer hard-coding a copy of this constant and drifting from it silently. It does NOT depend on the caller: `effectiveShellMode` is what YOU get, this is what an unconfigured member gets. */
+    unstatedMemberShellMode: OrgExperienceSettingsDtoUnstatedMemberShellMode;
     /** @nullable */
     updatedByActorId: string | null;
     /** @nullable */

package/dist/models/orgExperienceSettingsDtoEffectiveShellMode.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * Space Registry API
+ * OpenAPI spec version: 0.1.0
+ */
+/**
+ * THE FIELD A SHELL READS: which mode THIS caller is in, with the org-wide setting, the per-group overrides and the caller's role already applied. Always present — there is always an answer, and an unconfigured org resolves to the behaviour it already has. The fields above are the POLICY an administrator edits; a shell that reads them instead would re-implement this resolution and drift from it. Still presentation only: it grants and withholds nothing.
+ */
+export type OrgExperienceSettingsDtoEffectiveShellMode = typeof OrgExperienceSettingsDtoEffectiveShellMode[keyof typeof OrgExperienceSettingsDtoEffectiveShellMode];
+export declare const OrgExperienceSettingsDtoEffectiveShellMode: {
+    readonly full: "full";
+    readonly 'portal-focused': "portal-focused";
+};

package/dist/models/orgExperienceSettingsDtoEffectiveShellMode.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * Space Registry API
+ * OpenAPI spec version: 0.1.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrgExperienceSettingsDtoEffectiveShellMode = void 0;
+exports.OrgExperienceSettingsDtoEffectiveShellMode = {
+    full: 'full',
+    'portal-focused': 'portal-focused',
+};

package/dist/models/orgExperienceSettingsDtoMemberShellMode.d.ts

@@ -4,7 +4,7 @@
  * OpenAPI spec version: 0.1.0
  */
 /**
- * How the shell presents itself to an ordinary member. Absent = the full shell (today's behaviour). Administrators are never confined.
+ * How the shell presents itself to an ordinary member. Absent leaves today's behaviour in place, which is portal-focused for an ordinary member — see `effectiveShellMode`, which is the field a shell should read. Administrators are never confined.
  */
 export type OrgExperienceSettingsDtoMemberShellMode = typeof OrgExperienceSettingsDtoMemberShellMode[keyof typeof OrgExperienceSettingsDtoMemberShellMode];
 export declare const OrgExperienceSettingsDtoMemberShellMode: {

package/dist/models/orgExperienceSettingsDtoUnstatedMemberShellMode.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * Space Registry API
+ * OpenAPI spec version: 0.1.0
+ */
+/**
+ * What an ordinary member gets when this organization has stated nothing — the platform default, not a value anyone configured. Published because an administrator looking at an unconfigured policy still needs to know what their members see, and the alternative is every consumer hard-coding a copy of this constant and drifting from it silently. It does NOT depend on the caller: `effectiveShellMode` is what YOU get, this is what an unconfigured member gets.
+ */
+export type OrgExperienceSettingsDtoUnstatedMemberShellMode = typeof OrgExperienceSettingsDtoUnstatedMemberShellMode[keyof typeof OrgExperienceSettingsDtoUnstatedMemberShellMode];
+export declare const OrgExperienceSettingsDtoUnstatedMemberShellMode: {
+    readonly full: "full";
+    readonly 'portal-focused': "portal-focused";
+};

package/dist/models/orgExperienceSettingsDtoUnstatedMemberShellMode.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * Space Registry API
+ * OpenAPI spec version: 0.1.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrgExperienceSettingsDtoUnstatedMemberShellMode = void 0;
+exports.OrgExperienceSettingsDtoUnstatedMemberShellMode = {
+    full: 'full',
+    'portal-focused': 'portal-focused',
+};

package/dist/models/resourceRoleCatalogueResponseDto.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * Space Registry API
+ * OpenAPI spec version: 0.1.0
+ */
+import type { ResourceRoleDeclarationResponseDto } from './resourceRoleDeclarationResponseDto.js';
+export interface ResourceRoleCatalogueResponseDto {
+    roles: ResourceRoleDeclarationResponseDto[];
+}

package/dist/models/resourceRoleCatalogueResponseDto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/resourceRoleCatalogueResponseDtoDataEnvelope.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * Space Registry API
+ * OpenAPI spec version: 0.1.0
+ */
+import type { ResourceRoleCatalogueResponseDto } from './resourceRoleCatalogueResponseDto.js';
+export interface ResourceRoleCatalogueResponseDtoDataEnvelope {
+    data: ResourceRoleCatalogueResponseDto;
+}

package/dist/models/resourceRoleCatalogueResponseDtoDataEnvelope.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/resourceRoleDeclarationResponseDto.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * Space Registry API
+ * OpenAPI spec version: 0.1.0
+ */
+import type { ResourceRoleDeclarationResponseDtoResolvedAtSpaceKindsItem } from './resourceRoleDeclarationResponseDtoResolvedAtSpaceKindsItem.js';
+export interface ResourceRoleDeclarationResponseDto {
+    /** The STABLE identifier a binding names, as `<resourceKind>.<role>`. It survives a re-implementation of the thing behind it, so it encodes no biome id, route or service name — a key that moved would silently invalidate every binding that names it. */
+    roleKey: string;
+    /** The heading a person reads on a settings surface. */
+    title: string;
+    /** What choosing a resource for this role DOES, in the reader’s words. An administrator picking an agent for a role they cannot picture is the failure a settings surface exists to end. */
+    description: string;
+    /** The space tiers a CONSUMER resolves this role at — NOT where a binding may be stated (a binding may be stated anywhere on the ladder and is inherited downward). A surface reads this to tell an administrator the truth about what they are stating, per role, instead of presenting identical controls with different real behaviours. */
+    resolvedAtSpaceKinds: ResourceRoleDeclarationResponseDtoResolvedAtSpaceKindsItem[];
+    /** The space that OWNS this declaration — `xema://biomes/<id>` for a biome-contributed role, `xema://system` for a platform seed. Derived from the contribution owner; never authored. */
+    ownerSpaceRef: string;
+    /** The biome that declared it, when a biome did. Absent for a system seed. */
+    biomeId?: string;
+    /** The version of that biome at the time it was declared. */
+    biomeVersion?: string;
+}

package/dist/models/resourceRoleDeclarationResponseDto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/resourceRoleDeclarationResponseDtoResolvedAtSpaceKindsItem.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * Space Registry API
+ * OpenAPI spec version: 0.1.0
+ */
+export type ResourceRoleDeclarationResponseDtoResolvedAtSpaceKindsItem = typeof ResourceRoleDeclarationResponseDtoResolvedAtSpaceKindsItem[keyof typeof ResourceRoleDeclarationResponseDtoResolvedAtSpaceKindsItem];
+export declare const ResourceRoleDeclarationResponseDtoResolvedAtSpaceKindsItem: {
+    readonly system: "system";
+    readonly org: "org";
+    readonly project: "project";
+    readonly app: "app";
+    readonly session: "session";
+    readonly biome: "biome";
+    readonly user: "user";
+};

package/dist/models/resourceRoleDeclarationResponseDtoResolvedAtSpaceKindsItem.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * Space Registry API
+ * OpenAPI spec version: 0.1.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceRoleDeclarationResponseDtoResolvedAtSpaceKindsItem = void 0;
+exports.ResourceRoleDeclarationResponseDtoResolvedAtSpaceKindsItem = {
+    system: 'system',
+    org: 'org',
+    project: 'project',
+    app: 'app',
+    session: 'session',
+    biome: 'biome',
+    user: 'user',
+};

package/dist/models/resourceRolesCatalogueControllerListParams.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * Space Registry API
+ * OpenAPI spec version: 0.1.0
+ */
+export type ResourceRolesCatalogueControllerListParams = {
+    /**
+     * Narrow to one kind, e.g. `launch-definition` — matched as the `<kind>.` prefix of the role key, the same narrowing the bindings list accepts.
+     */
+    resourceKind?: string;
+};

package/dist/models/resourceRolesCatalogueControllerListParams.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Generated by @xemahq/api-client-generator — do not edit manually.
+ * Space Registry API
+ * OpenAPI spec version: 0.1.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xemahq/space-registry-api-client",
-  "version": "0.2.10",
+  "version": "0.2.12",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [