@baukit/suite-client 0.12.2 → 0.13.0

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.
@@ -82,6 +82,8 @@ export interface CreditBalance {
82
82
  export type OrganizationStatus = 'active' | 'suspended';
83
83
  export interface OrganizationSummary {
84
84
  readonly organizationId: string;
85
+ /** Display name. Absent from a hub before Schlüsselbund C16. */
86
+ readonly name?: string;
85
87
  readonly status: OrganizationStatus;
86
88
  readonly productId: string;
87
89
  readonly tier: string;
@@ -92,6 +94,18 @@ export interface OrganizationSummary {
92
94
  /** Matches the latest `organization.updated` event, or 0 before the first. */
93
95
  readonly revision: number;
94
96
  }
97
+ export type OrganizationRole = 'owner' | 'admin' | 'billing' | 'member';
98
+ /** An organization in which a subject can use the calling product. */
99
+ export interface SubjectOrganization {
100
+ readonly organizationId: string;
101
+ readonly accountRole: OrganizationRole;
102
+ }
103
+ /** `GET /platform/v1/accounts/{suiteSubject}/organizations`, sorted by organization ID. */
104
+ export interface SubjectOrganizationPage {
105
+ readonly items: readonly SubjectOrganization[];
106
+ /** `null` on the last page. */
107
+ readonly nextCursor: string | null;
108
+ }
95
109
  /** Hub error codes the Rust credits port maps to typed errors. */
96
110
  export declare const PLATFORM_CREDIT_ERROR_CODES: readonly ["account_inactive", "credits_amount_invalid", "credits_idempotency_conflict", "credits_idempotency_key_invalid", "credits_insufficient", "credits_reservation_expired", "credits_reservation_not_found", "credits_wallet_unknown", "platform_credits_unavailable", "platform_subject_not_found"];
97
111
  export type PlatformCreditErrorCode = (typeof PLATFORM_CREDIT_ERROR_CODES)[number];
@@ -1 +1 @@
1
- {"version":3,"file":"platform.d.ts","sourceRoot":"","sources":["../src/platform.ts"],"names":[],"mappings":"AAAA,kFAAkF;AAClF,eAAO,MAAM,oBAAoB,0PAWvB,CAAC;AACX,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtE,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AACD,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,sBAAsB,EAAE,eAAe,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAChF,QAAQ,CAAC,iBAAiB,EAAE,eAAe,CAAC;IAC5C,QAAQ,CAAC,2BAA2B,EAAE;QACpC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;QAC9B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;KAC5B,CAAC;IACF,QAAQ,CAAC,qBAAqB,EAAE,eAAe,CAAC;IAChD,QAAQ,CAAC,mBAAmB,EAAE,eAAe,GAAG;QAAE,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;KAAE,CAAC;IACpF,QAAQ,CAAC,2BAA2B,EAAE,eAAe,GAAG;QACtD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC1B,QAAQ,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;QAC/C,QAAQ,CAAC,UAAU,EAAE,WAAW,GAAG,QAAQ,CAAC;KAC7C,CAAC;IACF,QAAQ,CAAC,iCAAiC,EAAE;QAC1C,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;QAChC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;QAC9B,QAAQ,CAAC,MAAM,EAAE,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;QACpD,QAAQ,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,QAAQ,CAAC;KAChE,CAAC;IACF,QAAQ,CAAC,cAAc,EAAE;QACvB,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;QAChC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;QAC9B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;KAC5B,CAAC;IACF,oDAAoD;IACpD,QAAQ,CAAC,sBAAsB,EAAE;QAC/B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;QAChC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;KAC3B,CAAC;IACF,QAAQ,CAAC,iBAAiB,EAAE,eAAe,GAAG;QAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAC3E;AAED,MAAM,MAAM,uBAAuB,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC;AACrF,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,uBAAuB,CAAC;IACzC,oBAAoB;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AACD,MAAM,WAAW,UAAU;IACzB,kCAAkC;IAClC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AACD,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AACD,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,oBAAoB;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AACD,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,SAAS,UAAU,EAAE,CAAC;IACtC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAC5B,QAAQ,CAAC,KAAK,EAAE,SAAS,UAAU,EAAE,CAAC;CACvC;AAED,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,WAAW,CAAC;AACxD,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;IACpC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC,+DAA+D;IAC/D,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,8EAA8E;IAC9E,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED,kEAAkE;AAClE,eAAO,MAAM,2BAA2B,4SAW9B,CAAC;AACX,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,2BAA2B,CAAC,CAAC,MAAM,CAAC,CAAC"}
1
+ {"version":3,"file":"platform.d.ts","sourceRoot":"","sources":["../src/platform.ts"],"names":[],"mappings":"AAAA,kFAAkF;AAClF,eAAO,MAAM,oBAAoB,0PAWvB,CAAC;AACX,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtE,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AACD,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,sBAAsB,EAAE,eAAe,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAChF,QAAQ,CAAC,iBAAiB,EAAE,eAAe,CAAC;IAC5C,QAAQ,CAAC,2BAA2B,EAAE;QACpC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;QAC9B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;KAC5B,CAAC;IACF,QAAQ,CAAC,qBAAqB,EAAE,eAAe,CAAC;IAChD,QAAQ,CAAC,mBAAmB,EAAE,eAAe,GAAG;QAAE,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;KAAE,CAAC;IACpF,QAAQ,CAAC,2BAA2B,EAAE,eAAe,GAAG;QACtD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC1B,QAAQ,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;QAC/C,QAAQ,CAAC,UAAU,EAAE,WAAW,GAAG,QAAQ,CAAC;KAC7C,CAAC;IACF,QAAQ,CAAC,iCAAiC,EAAE;QAC1C,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;QAChC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;QAC9B,QAAQ,CAAC,MAAM,EAAE,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;QACpD,QAAQ,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,QAAQ,CAAC;KAChE,CAAC;IACF,QAAQ,CAAC,cAAc,EAAE;QACvB,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;QAChC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;QAC9B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;KAC5B,CAAC;IACF,oDAAoD;IACpD,QAAQ,CAAC,sBAAsB,EAAE;QAC/B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;QAChC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;KAC3B,CAAC;IACF,QAAQ,CAAC,iBAAiB,EAAE,eAAe,GAAG;QAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAC3E;AAED,MAAM,MAAM,uBAAuB,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC;AACrF,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,uBAAuB,CAAC;IACzC,oBAAoB;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AACD,MAAM,WAAW,UAAU;IACzB,kCAAkC;IAClC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AACD,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AACD,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,oBAAoB;IACpB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AACD,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,SAAS,UAAU,EAAE,CAAC;IACtC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAC5B,QAAQ,CAAC,KAAK,EAAE,SAAS,UAAU,EAAE,CAAC;CACvC;AAED,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,WAAW,CAAC;AACxD,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,gEAAgE;IAChE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;IACpC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC,+DAA+D;IAC/D,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,8EAA8E;IAC9E,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,QAAQ,CAAC;AACxE,sEAAsE;AACtE,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,WAAW,EAAE,gBAAgB,CAAC;CACxC;AACD,2FAA2F;AAC3F,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,KAAK,EAAE,SAAS,mBAAmB,EAAE,CAAC;IAC/C,+BAA+B;IAC/B,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,kEAAkE;AAClE,eAAO,MAAM,2BAA2B,4SAW9B,CAAC;AACX,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,2BAA2B,CAAC,CAAC,MAAM,CAAC,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"platform.js","sourceRoot":"","sources":["../src/platform.ts"],"names":[],"mappings":"AAAA,kFAAkF;AAClF,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,sBAAsB;IACtB,iBAAiB;IACjB,2BAA2B;IAC3B,qBAAqB;IACrB,mBAAmB;IACnB,2BAA2B;IAC3B,iCAAiC;IACjC,cAAc;IACd,sBAAsB;IACtB,iBAAiB;CACT,CAAC;AA2FX,kEAAkE;AAClE,MAAM,CAAC,MAAM,2BAA2B,GAAG;IACzC,kBAAkB;IAClB,wBAAwB;IACxB,8BAA8B;IAC9B,iCAAiC;IACjC,sBAAsB;IACtB,6BAA6B;IAC7B,+BAA+B;IAC/B,wBAAwB;IACxB,8BAA8B;IAC9B,4BAA4B;CACpB,CAAC"}
1
+ {"version":3,"file":"platform.js","sourceRoot":"","sources":["../src/platform.ts"],"names":[],"mappings":"AAAA,kFAAkF;AAClF,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,sBAAsB;IACtB,iBAAiB;IACjB,2BAA2B;IAC3B,qBAAqB;IACrB,mBAAmB;IACnB,2BAA2B;IAC3B,iCAAiC;IACjC,cAAc;IACd,sBAAsB;IACtB,iBAAiB;CACT,CAAC;AA0GX,kEAAkE;AAClE,MAAM,CAAC,MAAM,2BAA2B,GAAG;IACzC,kBAAkB;IAClB,wBAAwB;IACxB,8BAA8B;IAC9B,iCAAiC;IACjC,sBAAsB;IACtB,6BAA6B;IAC7B,+BAA+B;IAC/B,wBAAwB;IACxB,8BAA8B;IAC9B,4BAA4B;CACpB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@baukit/suite-client",
3
- "version": "0.12.2",
3
+ "version": "0.13.0",
4
4
  "description": "Headless suite linking, authorization state and connected app clients.",
5
5
  "license": "MIT",
6
6
  "author": "Patrick Koss",
@@ -69,8 +69,8 @@
69
69
  "vitest": "5.0.3"
70
70
  },
71
71
  "peerDependencies": {
72
- "@baukit/integrations-client": "^0.12.2",
73
- "@baukit/localization-core": "^0.12.2"
72
+ "@baukit/integrations-client": "^0.13.0",
73
+ "@baukit/localization-core": "^0.13.0"
74
74
  },
75
75
  "dependencies": {
76
76
  "@noble/curves": "1.9.7"
@@ -6,6 +6,7 @@ import {
6
6
  type CreditBalance,
7
7
  type CreditReservation,
8
8
  type OrganizationSummary,
9
+ type SubjectOrganizationPage,
9
10
  type PlatformEventPayloads,
10
11
  } from './index.js';
11
12
 
@@ -72,6 +73,7 @@ it('matches recorded hub credit and organization responses', () => {
72
73
  };
73
74
  const summary: OrganizationSummary = {
74
75
  organizationId: '018f1234-5678-7abc-8def-012345678901',
76
+ name: 'Summary',
75
77
  status: 'active',
76
78
  productId: 'runtime_analyzer',
77
79
  tier: 'professional',
@@ -84,6 +86,35 @@ it('matches recorded hub credit and organization responses', () => {
84
86
  expect(body('reservationPending')).toEqual(pending);
85
87
  expect(body('reservationSettled')).toEqual({ ...pending, charged: 4, status: 'settled' });
86
88
  expect(body('organizationSummary')).toEqual(summary);
89
+ const withoutName: OrganizationSummary = {
90
+ organizationId: summary.organizationId,
91
+ status: summary.status,
92
+ productId: summary.productId,
93
+ tier: summary.tier,
94
+ features: summary.features,
95
+ paidQuantity: summary.paidQuantity,
96
+ assignedSeats: summary.assignedSeats,
97
+ revision: summary.revision,
98
+ };
99
+ expect(body('organizationSummaryWithoutName')).toStrictEqual(withoutName);
100
+ });
101
+
102
+ it('matches recorded subject organization pages', () => {
103
+ const first: SubjectOrganizationPage = {
104
+ items: [
105
+ { organizationId: '018f1234-5678-7abc-8def-012345678901', accountRole: 'owner' },
106
+ { organizationId: '018f1234-5678-7abc-8def-012345678902', accountRole: 'member' },
107
+ ],
108
+ nextCursor: 'b3Jncy1wYWdlLTI',
109
+ };
110
+ const last: SubjectOrganizationPage = {
111
+ items: [{ organizationId: '018f1234-5678-7abc-8def-012345678903', accountRole: 'admin' }],
112
+ nextCursor: null,
113
+ };
114
+ const empty: SubjectOrganizationPage = { items: [], nextCursor: null };
115
+ expect(body('subjectOrganizationsFirstPage')).toEqual(first);
116
+ expect(body('subjectOrganizationsLastPage')).toEqual(last);
117
+ expect(body('subjectOrganizationsEmpty')).toEqual(empty);
87
118
  });
88
119
 
89
120
  it('lists the recorded credit error codes', () => {
package/src/platform.ts CHANGED
@@ -90,6 +90,8 @@ export interface CreditBalance {
90
90
  export type OrganizationStatus = 'active' | 'suspended';
91
91
  export interface OrganizationSummary {
92
92
  readonly organizationId: string;
93
+ /** Display name. Absent from a hub before Schlüsselbund C16. */
94
+ readonly name?: string;
93
95
  readonly status: OrganizationStatus;
94
96
  readonly productId: string;
95
97
  readonly tier: string;
@@ -101,6 +103,19 @@ export interface OrganizationSummary {
101
103
  readonly revision: number;
102
104
  }
103
105
 
106
+ export type OrganizationRole = 'owner' | 'admin' | 'billing' | 'member';
107
+ /** An organization in which a subject can use the calling product. */
108
+ export interface SubjectOrganization {
109
+ readonly organizationId: string;
110
+ readonly accountRole: OrganizationRole;
111
+ }
112
+ /** `GET /platform/v1/accounts/{suiteSubject}/organizations`, sorted by organization ID. */
113
+ export interface SubjectOrganizationPage {
114
+ readonly items: readonly SubjectOrganization[];
115
+ /** `null` on the last page. */
116
+ readonly nextCursor: string | null;
117
+ }
118
+
104
119
  /** Hub error codes the Rust credits port maps to typed errors. */
105
120
  export const PLATFORM_CREDIT_ERROR_CODES = [
106
121
  'account_inactive',