@favish/staffbase-utils 0.16.0 → 0.17.0

package/dist/src/types/groups/CreateGroupBody.d.ts

@@ -0,0 +1,12 @@
+import { components } from './generated/groupsApi';
+/**
+ * Request body for creating a group.
+ *
+ * Thin alias over the machine-generated groups API schema so the public name
+ * stays stable even if `generated/groupsApi.ts` is regenerated. The write side
+ * of the spec is properly schematized, so this is sourced directly from codegen
+ * (unlike `Group`, whose read shape had to be curated from prod because
+ * the spec's `Group` schema does not match the runtime).
+ */
+export type CreateGroupBody = components['schemas']['GroupCreate'];
+//# sourceMappingURL=CreateGroupBody.d.ts.map

package/dist/src/types/groups/CreateGroupBody.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CreateGroupBody.d.ts","sourceRoot":"","sources":["../../../../src/types/groups/CreateGroupBody.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAEvD;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAA"}

package/dist/src/types/groups/Group.d.ts

@@ -0,0 +1,47 @@
+import { ChannelLink } from '../content/ChannelLink';
+import { GroupAccessors } from './GroupAccessors';
+import { GroupAdminsWithGroups } from './GroupAdminsWithGroups';
+import { GroupConfig } from './GroupConfig';
+import { GroupUser } from './GroupUser';
+import { GroupUsers } from './GroupUsers';
+/**
+ * A group as returned by the Staffbase read endpoints (`GET /api/groups` and
+ * `GET /api/groups/{id}`).
+ *
+ * Curated, not machine-generated: the official groups OpenAPI `Group` schema
+ * does NOT match the runtime (it models the v2026 management API with
+ * `externalId`/`inclusions`/`exclusions`; only `id`/`name`/`type` overlap).
+ * Every field below is grounded in a live prod sweep of all 45 groups (45 list
+ * items + 6 single reads). Group membership is PII; only key names and types
+ * were extracted, never values.
+ *
+ * Field names match the wire format verbatim, including the capitalised `ID`
+ * suffix on `accessorIDs`, `adminIDs` and `ownerID`. The required/optional
+ * split reflects observed presence: `accessorIDs`/`adminIDs`/`ownerID`/
+ * `ownerType`/`config`/`links`/`rights` were present on 45/45 list items, while
+ * `accessors`, `owner`, `adminsWithGroups` and `users` were present only on the
+ * single reads (6/6) and never on the list items, so they are optional.
+ * `adminIDs` was an empty array for some groups but always present.
+ *
+ * `links` reuses {@link ChannelLink}: every entry was `{ method, href }`, some
+ * also carrying the optional `parameters`/`form` descriptors, matching the
+ * channel link shape exactly.
+ */
+export interface Group {
+    id: string;
+    name: string;
+    type: string;
+    accessorIDs: string[];
+    adminIDs: string[];
+    ownerID: string;
+    ownerType: string;
+    config: GroupConfig;
+    entityType: string;
+    links: Record<string, ChannelLink>;
+    rights: string[];
+    accessors?: GroupAccessors;
+    owner?: GroupUser;
+    adminsWithGroups?: GroupAdminsWithGroups;
+    users?: GroupUsers;
+}
+//# sourceMappingURL=Group.d.ts.map

package/dist/src/types/groups/Group.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Group.d.ts","sourceRoot":"","sources":["../../../../src/types/groups/Group.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AACpE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAE9C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,EAAE,CAAA;IACrB,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,WAAW,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IAClC,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,SAAS,CAAC,EAAE,cAAc,CAAA;IAC1B,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,gBAAgB,CAAC,EAAE,qBAAqB,CAAA;IACxC,KAAK,CAAC,EAAE,UAAU,CAAA;CACnB"}

package/dist/src/types/groups/GroupAccessors.d.ts

@@ -0,0 +1,13 @@
+import { GroupBranch } from './GroupBranch';
+/**
+ * The `accessors` object on a group's single-read response.
+ *
+ * Grounded in a live prod sweep (6/6 single reads): every `accessors` carried a
+ * single key, `branch`, holding the platform branch entity the group belongs
+ * to. Present only on single reads (`GET /api/groups/{id}`), never on the list
+ * items. The official groups spec does not document this shape.
+ */
+export interface GroupAccessors {
+    branch: GroupBranch;
+}
+//# sourceMappingURL=GroupAccessors.d.ts.map

package/dist/src/types/groups/GroupAccessors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupAccessors.d.ts","sourceRoot":"","sources":["../../../../src/types/groups/GroupAccessors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAEhD;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,WAAW,CAAA;CACpB"}

package/dist/src/types/groups/GroupAdminsWithGroups.d.ts

@@ -0,0 +1,18 @@
+import { ChannelLink } from '../content/ChannelLink';
+/**
+ * The `adminsWithGroups` object on a group's single-read response.
+ *
+ * Grounded in a live prod sweep (6 single reads): `links` (a HAL link map) and
+ * `rights` (a string array) were present on 6/6, while `groups` (an embedded
+ * paginated collection of `{ total, data }`) appeared on only 1/6 and is
+ * therefore optional. Present only on single reads, never on the list items.
+ * The `groups` payload is an embedded collection of platform entities and is
+ * typed as an opaque record. The official groups spec does not document this
+ * shape.
+ */
+export interface GroupAdminsWithGroups {
+    links: Record<string, ChannelLink>;
+    rights: string[];
+    groups?: Record<string, unknown>;
+}
+//# sourceMappingURL=GroupAdminsWithGroups.d.ts.map

package/dist/src/types/groups/GroupAdminsWithGroups.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupAdminsWithGroups.d.ts","sourceRoot":"","sources":["../../../../src/types/groups/GroupAdminsWithGroups.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAEzD;;;;;;;;;;GAUG;AACH,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IAClC,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACjC"}

package/dist/src/types/groups/GroupBranch.d.ts

@@ -0,0 +1,23 @@
+/**
+ * A platform branch entity as embedded in a group's `accessors.branch` on the
+ * single-read response.
+ *
+ * Grounded in a live prod sweep (6 branch entities across 6 single reads): all
+ * nine top-level keys below were present on 6/6. The nested `config`, `image`
+ * and `colors` objects are platform-controlled branch settings dumps and are
+ * typed as opaque records, since their inner shapes are tenant-wide
+ * configuration rather than part of the group read contract. The official
+ * groups spec does not document this shape.
+ */
+export interface GroupBranch {
+    id: string;
+    name: string;
+    slug: string;
+    tag: string;
+    config: Record<string, unknown>;
+    image: Record<string, unknown>;
+    colors: Record<string, unknown>;
+    created: string;
+    updated: string;
+}
+//# sourceMappingURL=GroupBranch.d.ts.map

package/dist/src/types/groups/GroupBranch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupBranch.d.ts","sourceRoot":"","sources":["../../../../src/types/groups/GroupBranch.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC/B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;CAChB"}

package/dist/src/types/groups/GroupConfig.d.ts

@@ -0,0 +1,16 @@
+import { GroupConfigLocalization } from './GroupConfigLocalization';
+/**
+ * A group's `config` object as returned by the read endpoints
+ * (`GET /api/groups`, `GET /api/groups/{id}`).
+ *
+ * Grounded in a live prod sweep of all 45 groups: every group's `config`
+ * carried exactly two keys, `localization` (a per-locale map keyed by locale
+ * code) and `showInOverview` (boolean), both present on 45/45 list items and
+ * 6/6 single reads. The head-start hint of `icon`/`imageUrl`/`link` was not
+ * observed on any group and is therefore not modeled.
+ */
+export interface GroupConfig {
+    localization: Record<string, GroupConfigLocalization>;
+    showInOverview: boolean;
+}
+//# sourceMappingURL=GroupConfig.d.ts.map

package/dist/src/types/groups/GroupConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupConfig.d.ts","sourceRoot":"","sources":["../../../../src/types/groups/GroupConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AAExE;;;;;;;;;GASG;AACH,MAAM,WAAW,WAAW;IAC1B,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAA;IACrD,cAAc,EAAE,OAAO,CAAA;CACxB"}

package/dist/src/types/groups/GroupConfigLocalization.d.ts

@@ -0,0 +1,13 @@
+/**
+ * One per-locale entry of a group's `config.localization` map.
+ *
+ * Grounded in a live prod sweep of all 45 groups (51 localization entries
+ * across list + single reads): every entry carried exactly one key, `title`,
+ * always a string. The spec does not document this shape (the official groups
+ * `Group` schema models a different management API and does not match the
+ * runtime at all).
+ */
+export interface GroupConfigLocalization {
+    title: string;
+}
+//# sourceMappingURL=GroupConfigLocalization.d.ts.map

package/dist/src/types/groups/GroupConfigLocalization.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupConfigLocalization.d.ts","sourceRoot":"","sources":["../../../../src/types/groups/GroupConfigLocalization.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,MAAM,CAAA;CACd"}

package/dist/src/types/groups/GroupUser.d.ts

@@ -0,0 +1,51 @@
+/**
+ * A platform user entity as embedded in a group's single-read response, used
+ * both for `owner` and for each item of `users.data`.
+ *
+ * Grounded in a live prod sweep (306 user entities across 6 single reads). The
+ * required/optional split below reflects observed presence counts: the core
+ * identity and account fields were present on 306/306, while `avatar`
+ * (276/306), `recoveryCode` (11/306), `secret` (20/306) and `deactivatedAt`
+ * (2/306) were genuinely absent on some users. `mandatoryGroupIDs` and
+ * `phoneNumber` were always `null` in the sweep; `department`, `location` and
+ * `position` were string-or-null.
+ *
+ * Nested platform sub-objects (`avatar`, `config`, `creation`, `profile`,
+ * `recoveryCode`, `role`, `secret`, `userName`) are full entity dumps and are
+ * typed as opaque records: their inner shapes are platform-controlled, vary by
+ * tenant (`profile` is a free-form custom-field map), and are not part of the
+ * contract this read type guarantees. The official groups spec does not
+ * document this user shape at all.
+ */
+export interface GroupUser {
+    id: string;
+    firstName: string;
+    lastName: string;
+    entityType: string;
+    status: string;
+    activated: string;
+    branchID: string;
+    branchRole: string;
+    externalID: string;
+    publicEmailAddress: string;
+    department: string | null;
+    location: string | null;
+    position: string | null;
+    mandatoryGroupIDs: string[] | null;
+    phoneNumber: string | null;
+    groupIDs: string[];
+    tags: string[];
+    emails: Record<string, unknown>[];
+    config: Record<string, unknown>;
+    creation: Record<string, unknown>;
+    profile: Record<string, unknown>;
+    role: Record<string, unknown>;
+    userName: Record<string, unknown>;
+    avatar?: Record<string, unknown>;
+    recoveryCode?: Record<string, unknown>;
+    secret?: Record<string, unknown>;
+    deactivatedAt?: string;
+    created: string;
+    updated: string;
+}
+//# sourceMappingURL=GroupUser.d.ts.map

package/dist/src/types/groups/GroupUser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupUser.d.ts","sourceRoot":"","sources":["../../../../src/types/groups/GroupUser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,iBAAiB,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IAClC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAA;IACjC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC/B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC7B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;CAChB"}

package/dist/src/types/groups/GroupUsers.d.ts

@@ -0,0 +1,21 @@
+import { ChannelLink } from '../content/ChannelLink';
+import { GroupUser } from './GroupUser';
+/**
+ * The `users` object on a group's single-read response: a paginated collection
+ * of the group's members.
+ *
+ * Grounded in a live prod sweep (6/6 single reads): the pagination envelope
+ * (`total`, `limit`, `offset`), the `data` array of {@link GroupUser} members,
+ * the `links` HAL map and the `rights` string array were all present on 6/6.
+ * Present only on single reads (`GET /api/groups/{id}`), never on the list
+ * items. The official groups spec does not document this shape.
+ */
+export interface GroupUsers {
+    total: number;
+    limit: number;
+    offset: number;
+    data: GroupUser[];
+    links: Record<string, ChannelLink>;
+    rights: string[];
+}
+//# sourceMappingURL=GroupUsers.d.ts.map

package/dist/src/types/groups/GroupUsers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupUsers.d.ts","sourceRoot":"","sources":["../../../../src/types/groups/GroupUsers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAE5C;;;;;;;;;GASG;AACH,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,SAAS,EAAE,CAAA;IACjB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IAClC,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB"}

package/dist/src/types/groups/UpdateGroupBody.d.ts

@@ -0,0 +1,12 @@
+import { components } from './generated/groupsApi';
+/**
+ * Request body for updating a group.
+ *
+ * Thin alias over the machine-generated groups API schema so the public name
+ * stays stable even if `generated/groupsApi.ts` is regenerated. The write side
+ * of the spec is properly schematized, so this is sourced directly from codegen
+ * (unlike `Group`, whose read shape had to be curated from prod because
+ * the spec's `Group` schema does not match the runtime).
+ */
+export type UpdateGroupBody = components['schemas']['GroupUpdate'];
+//# sourceMappingURL=UpdateGroupBody.d.ts.map

package/dist/src/types/groups/UpdateGroupBody.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UpdateGroupBody.d.ts","sourceRoot":"","sources":["../../../../src/types/groups/UpdateGroupBody.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAEvD;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAA"}