@stackfactor/client-api 1.9.2 → 1.10.0

package/dist/esm/lib/metricTemplate.js

@@ -0,0 +1,130 @@
+import { client, request } from "./axiosClient.js";
+/**
+ * Create metric template and set information
+ * @param {Object} data
+ * @param {String} token Authorization token
+ * @returns {Promise<MetricTemplateRecord>}
+ */
+export const createMetricTemplate = (data, token) => request(client.put("/api/v1/admin/metrictemplates", { data }, { headers: { authorization: token } }));
+/**
+ * Delete metric template
+ * @param {String} id The id of the record to be deleted
+ * @param {String} comments The comments included with the deletion
+ * @param {String} token Authorization token
+ * @returns {Promise<MetricTemplateRecord>}
+ */
+export const deleteMetricTemplate = (id, comments, token) => {
+    const data = { id };
+    if (comments)
+        data.comments = comments;
+    return request(client.delete("/api/v1/admin/metrictemplates/", { headers: { authorization: token }, data }));
+};
+/**
+ * Discard the metric template draft changes
+ * @param {String} id The id of the record to be discarded
+ * @param {String} token Authorization token
+ * @returns {Promise<MetricTemplateRecord>}
+ */
+export const discardMetricTemplateChanges = (id, token) => request(client.get(`/api/v1/admin/metrictemplates/discard/${id}`, { headers: { authorization: token } }));
+/**
+ * Get metric template information
+ * @param {String} id The id of the record
+ * @param {String} version The version of the record
+ * @param {Boolean} returnNullIfVersionNotFound When true it will return null if the version is not found
+ * @param {String} token Authorization token
+ * @returns {Promise<MetricTemplateRecord | null>}
+ */
+export const getMetricTemplateInformationById = (id, version, returnNullIfVersionNotFound, token) => request(client.get(`/api/v1/admin/metrictemplates/${id}/${version}/${returnNullIfVersionNotFound}`, {
+    headers: { authorization: token },
+}));
+/**
+ * Get metric template list
+ * @param {Array<String>} filter The filter used to select the records
+ * @param {String} version The version to be retrieved
+ * @param {Boolean} includeDeleted When true it will return the deleted records as well
+ * @param {String} details The level of detail to return ("ID", "NAME", "DEFAULT")
+ * @param {String} token Authorization token
+ * @returns {Promise<MetricTemplateRecord[]>}
+ */
+export const getMetricTemplateList = (filter, version, includeDeleted, details, token) => {
+    const requestData = { includeDeleted, details, version };
+    if (filter)
+        requestData.filter = filter;
+    return request(client.post("/api/v1/admin/metrictemplates", requestData, { headers: { authorization: token } }));
+};
+/**
+ * Publish metric template
+ * @param {String} id The id of the record to be published
+ * @param {String} comments The comments to be include with the request
+ * @param {String} token Authorization token
+ * @returns {Promise<MetricTemplateRecord>}
+ */
+export const publishMetricTemplate = (id, comments, token) => {
+    const data = {};
+    if (comments)
+        data.comments = comments;
+    return request(client.post(`/api/v1/admin/metrictemplates/publish/${id}`, data, { headers: { authorization: token } }));
+};
+/**
+ * Set metric template information
+ * @param {String} id The id of the record to be updated
+ * @param {Object} data Data used to update the record
+ * @param {String} token Authorization token
+ * @returns {Promise<MetricTemplateRecord>}
+ */
+export const setMetricTemplateInformation = (id, data, token) => request(client.post(`/api/v1/admin/metrictemplates/update`, { data, id }, { headers: { authorization: token } }));
+/**
+ * Update the metric template tags
+ * @param {String} id The id of the template to be updated
+ * @param {Object} tags Updated template tags
+ * @param {String} token Authorization token
+ * @returns {Promise<MetricTemplateRecord>}
+ */
+export const setMetricTemplateTags = (id, tags, token) => request(client.post(`/api/v1/admin/metrictemplates/updatetags`, { tags, id }, {
+    headers: { authorization: token },
+}));
+/**
+ * Get the metric template related control templates
+ * @param {String} id The id of the record
+ * @param {String} details The level of detail to return ("ID", "NAME", "DEFAULT")
+ * @param {String} version The version to be retrieved
+ * @param {Boolean} includeDeleted When true it will return the deleted records as well
+ * @param {Boolean} returnDefaultIfVersionNotAvailable Return the default version if published not available
+ * @param {String} token Authorization token
+ * @returns {Promise<RelatedRecordOrId[]>}
+ */
+export const getMetricTemplateRelatedControlTemplates = (id, details, version, includeDeleted, returnDefaultIfVersionNotAvailable, token) => request(client.post(`/api/v1/admin/metrictemplates/controltemplates/${id}`, { details, version, includeDeleted, returnDefaultIfVersionNotAvailable }, { headers: { authorization: token } }));
+/**
+ * Get the metric template related requirement templates
+ * @param {String} id The id of the record
+ * @param {String} details The level of detail to return ("ID", "NAME", "DEFAULT")
+ * @param {String} version The version to be retrieved
+ * @param {Boolean} includeDeleted When true it will return the deleted records as well
+ * @param {Boolean} returnDefaultIfVersionNotAvailable Return the default version if published not available
+ * @param {String} token Authorization token
+ * @returns {Promise<RelatedRecordOrId[]>}
+ */
+export const getMetricTemplateRelatedRequirementTemplates = (id, details, version, includeDeleted, returnDefaultIfVersionNotAvailable, token) => request(client.post(`/api/v1/admin/metrictemplates/requirementtemplates/${id}`, { details, version, includeDeleted, returnDefaultIfVersionNotAvailable }, { headers: { authorization: token } }));
+/**
+ * Get the metric template related standard templates
+ * @param {String} id The id of the record
+ * @param {String} details The level of detail to return ("ID", "NAME", "DEFAULT")
+ * @param {String} version The version to be retrieved
+ * @param {Boolean} includeDeleted When true it will return the deleted records as well
+ * @param {Boolean} returnDefaultIfVersionNotAvailable Return the default version if published not available
+ * @param {String} token Authorization token
+ * @returns {Promise<RelatedRecordOrId[]>}
+ */
+export const getMetricTemplateRelatedStandardTemplates = (id, details, version, includeDeleted, returnDefaultIfVersionNotAvailable, token) => request(client.post(`/api/v1/admin/metrictemplates/standardtemplates/${id}`, { details, version, includeDeleted, returnDefaultIfVersionNotAvailable }, { headers: { authorization: token } }));
+/**
+ * Get the metric template related policy templates
+ * @param {String} id The id of the record
+ * @param {String} details The level of detail to return ("ID", "NAME", "DEFAULT")
+ * @param {String} version The version to be retrieved
+ * @param {Boolean} includeDeleted When true it will return the deleted records as well
+ * @param {Boolean} returnDefaultIfVersionNotAvailable Return the default version if published not available
+ * @param {String} token Authorization token
+ * @returns {Promise<RelatedRecordOrId[]>}
+ */
+export const getMetricTemplateRelatedPolicyTemplates = (id, details, version, includeDeleted, returnDefaultIfVersionNotAvailable, token) => request(client.post(`/api/v1/admin/metrictemplates/policytemplates/${id}`, { details, version, includeDeleted, returnDefaultIfVersionNotAvailable }, { headers: { authorization: token } }));
+//# sourceMappingURL=metricTemplate.js.map

package/dist/esm/lib/metricTemplate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metricTemplate.js","sourceRoot":"","sources":["../../../src/lib/metricTemplate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAYnD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,IAA4B,EAAE,KAAa,EAAiC,EAAE,CACjH,OAAO,CAAuB,MAAM,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;AAE9H;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,EAAU,EAAE,QAAgB,EAAE,KAAa,EAAiC,EAAE;IACjH,MAAM,IAAI,GAAsC,EAAE,EAAE,EAAE,CAAC;IACvD,IAAI,QAAQ;QAAE,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IACvC,OAAO,OAAO,CACZ,MAAM,CAAC,MAAM,CAAC,gCAAgC,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,CAC7F,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,EAAU,EAAE,KAAa,EAAiC,EAAE,CACvG,OAAO,CACL,MAAM,CAAC,GAAG,CAAC,yCAAyC,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CACjG,CAAC;AAEJ;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAC9C,EAAU,EACV,OAAe,EACf,2BAAoC,EACpC,KAAa,EACyB,EAAE,CACxC,OAAO,CACL,MAAM,CAAC,GAAG,CAAC,iCAAiC,EAAE,IAAI,OAAO,IAAI,2BAA2B,EAAE,EAAE;IAC1F,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CAAC,CACH,CAAC;AAEJ;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,MAAgB,EAChB,OAAe,EACf,cAAuB,EACvB,OAAe,EACf,KAAa,EACoB,EAAE;IACnC,MAAM,WAAW,GAKb,EAAE,cAAc,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;IACzC,IAAI,MAAM;QAAE,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC;IACxC,OAAO,OAAO,CACZ,MAAM,CAAC,IAAI,CAAC,+BAA+B,EAAE,WAAW,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CACjG,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,EAAU,EAAE,QAAgB,EAAE,KAAa,EAAiC,EAAE;IAClH,MAAM,IAAI,GAA0B,EAAE,CAAC;IACvC,IAAI,QAAQ;QAAE,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IACvC,OAAO,OAAO,CACZ,MAAM,CAAC,IAAI,CAAC,yCAAyC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CACxG,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,EAAU,EACV,IAA4B,EAC5B,KAAa,EACkB,EAAE,CACjC,OAAO,CACL,MAAM,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CACzG,CAAC;AAEJ;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,EAAU,EACV,IAA6B,EAC7B,KAAa,EACkB,EAAE,CACjC,OAAO,CACL,MAAM,CAAC,IAAI,CAAC,0CAA0C,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE;IACpE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CAAC,CACH,CAAC;AAEJ;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,wCAAwC,GAAG,CACtD,EAAU,EACV,OAAe,EACf,OAAe,EACf,cAAuB,EACvB,kCAA2C,EAC3C,KAAa,EACiB,EAAE,CAChC,OAAO,CACL,MAAM,CAAC,IAAI,CACT,kDAAkD,EAAE,EAAE,EACtD,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,kCAAkC,EAAE,EACxE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CACtC,CACF,CAAC;AAEJ;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,4CAA4C,GAAG,CAC1D,EAAU,EACV,OAAe,EACf,OAAe,EACf,cAAuB,EACvB,kCAA2C,EAC3C,KAAa,EACiB,EAAE,CAChC,OAAO,CACL,MAAM,CAAC,IAAI,CACT,sDAAsD,EAAE,EAAE,EAC1D,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,kCAAkC,EAAE,EACxE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CACtC,CACF,CAAC;AAEJ;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,yCAAyC,GAAG,CACvD,EAAU,EACV,OAAe,EACf,OAAe,EACf,cAAuB,EACvB,kCAA2C,EAC3C,KAAa,EACiB,EAAE,CAChC,OAAO,CACL,MAAM,CAAC,IAAI,CACT,mDAAmD,EAAE,EAAE,EACvD,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,kCAAkC,EAAE,EACxE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CACtC,CACF,CAAC;AAEJ;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,uCAAuC,GAAG,CACrD,EAAU,EACV,OAAe,EACf,OAAe,EACf,cAAuB,EACvB,kCAA2C,EAC3C,KAAa,EACiB,EAAE,CAChC,OAAO,CACL,MAAM,CAAC,IAAI,CACT,iDAAiD,EAAE,EAAE,EACrD,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,kCAAkC,EAAE,EACxE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CACtC,CACF,CAAC"}

package/dist/esm/lib/userExperiences.d.ts

@@ -0,0 +1,191 @@
+/** The fixed set of experiences, in display order. */
+export type ExperienceId = "default" | "student" | "teacher" | "channel" | "executive" | "newhire";
+/** A word whose label an experience can rename. */
+export type LabelTerm = "team" | "member" | "manager" | "role" | "skill" | "path" | "plan" | "mentor";
+/** A setting's value: toggles are booleans, text and choice settings strings. */
+export type SettingValue = boolean | string;
+/** One setting an experience exposes. */
+export interface ExperienceSetting {
+    key: string;
+    area: "onboarding" | "profile" | "app";
+    kind: "toggle" | "text" | "choice";
+    label: string;
+    description: string;
+    default: SettingValue;
+    options?: string[];
+    maxLength?: number;
+}
+/** An experience with its settings and default labels. */
+export interface ExperienceDefinition {
+    id: ExperienceId;
+    name: string;
+    description: string;
+    settings: ExperienceSetting[];
+    labels: Partial<Record<LabelTerm, string>>;
+}
+/** The settings catalog and the label terms. */
+export interface UserExperienceCatalog {
+    experiences: ExperienceDefinition[];
+    labelTerms: {
+        term: LabelTerm;
+        label: string;
+    }[];
+}
+/** Who a user experience includes or excludes. */
+export interface AudienceRules {
+    teams: {
+        teamId: string;
+        includeSubTeams: boolean;
+    }[];
+    groups: string[];
+    users: string[];
+}
+/** A user experience a person gets. */
+export interface ExperienceSummary {
+    userExperienceId: string;
+    name: string;
+    experience: ExperienceId;
+}
+/** Why a user experience does or does not apply to a person. */
+export type Verdict = "matches" | "excluded" | "notIncluded" | "windowEnded";
+/** The editable content of a user experience, as a draft or published version. */
+export interface UserExperienceVersion {
+    name: string;
+    description: string;
+    experience: ExperienceId;
+    newHireDays: number;
+    include: AudienceRules;
+    exclude: AudienceRules;
+    settings: Record<string, SettingValue>;
+    labels: Partial<Record<LabelTerm, string>>;
+    version: number;
+    schemaVersion: number;
+}
+/** A user experience document with its draft and published versions. */
+export interface UserExperienceDocument {
+    _id: string;
+    builtIn: boolean;
+    draft: UserExperienceVersion;
+    published?: UserExperienceVersion;
+    modified: boolean;
+    publishedVersion: number;
+    created: string;
+    lastUpdated: string;
+    lastPublished?: string;
+}
+/** One row of the list of user experiences. */
+export interface UserExperienceListItem {
+    _id: string;
+    builtIn: boolean;
+    name: string;
+    experience: ExperienceId;
+    status: "draft" | "published" | "modified";
+    include: AudienceRules;
+    exclude: AudienceRules;
+    newHireDays: number;
+    /** People the published version reaches; for the built-in, people nothing else reaches. */
+    people: number;
+}
+/** Whether one user experience applies to a person, and why. */
+export interface UserExperienceVerdict {
+    userExperienceId: string;
+    name: string;
+    experience: ExperienceId;
+    verdict: Verdict | "notPublished";
+    reason: string;
+}
+/** Who an unsaved version would reach. */
+export interface UserExperiencePreview {
+    reaches: {
+        userId: string;
+        otherExperiences: ExperienceSummary[];
+    }[];
+}
+/** One person's experiences with a verdict per user experience. */
+export interface UserExperienceExplanation {
+    experiences: ExperienceSummary[];
+    verdicts: UserExperienceVerdict[];
+}
+/**
+ * Get the settings catalog and the label terms.
+ * @param {string} authToken Authorization token
+ * @returns {Promise<UserExperienceCatalog>}
+ */
+export declare const getUserExperienceCatalog: (authToken: string) => Promise<UserExperienceCatalog>;
+/**
+ * List the tenant's user experiences with their status and reach.
+ * @param {string} authToken Authorization token
+ * @returns {Promise<UserExperienceListItem[]>}
+ */
+export declare const listUserExperiences: (authToken: string) => Promise<UserExperienceListItem[]>;
+/**
+ * Create a user experience as a draft.
+ * @param {Partial<UserExperienceVersion>} data The draft content
+ * @param {string} authToken Authorization token
+ * @returns {Promise<UserExperienceDocument>}
+ */
+export declare const createUserExperience: (data: Partial<UserExperienceVersion>, authToken: string) => Promise<UserExperienceDocument>;
+/**
+ * Get one user experience with its draft and published versions.
+ * @param {string} id The user experience id
+ * @param {string} authToken Authorization token
+ * @returns {Promise<UserExperienceDocument>}
+ */
+export declare const getUserExperience: (id: string, authToken: string) => Promise<UserExperienceDocument>;
+/**
+ * Update the draft of a user experience.
+ * @param {string} id The user experience id
+ * @param {Partial<UserExperienceVersion>} data The fields to change
+ * @param {string} authToken Authorization token
+ * @returns {Promise<UserExperienceDocument>}
+ */
+export declare const updateUserExperience: (id: string, data: Partial<UserExperienceVersion>, authToken: string) => Promise<UserExperienceDocument>;
+/**
+ * Publish the draft of a user experience.
+ * @param {string} id The user experience id
+ * @param {string} authToken Authorization token
+ * @returns {Promise<UserExperienceDocument>}
+ */
+export declare const publishUserExperience: (id: string, authToken: string) => Promise<UserExperienceDocument>;
+/**
+ * Discard the unpublished changes of a user experience.
+ * @param {string} id The user experience id
+ * @param {string} authToken Authorization token
+ * @returns {Promise<UserExperienceDocument>}
+ */
+export declare const discardUserExperienceChanges: (id: string, authToken: string) => Promise<UserExperienceDocument>;
+/**
+ * Delete a user experience.
+ * @param {string} id The user experience id
+ * @param {string} authToken Authorization token
+ * @returns {Promise<{ operation: "DONE" }>}
+ */
+export declare const deleteUserExperience: (id: string, authToken: string) => Promise<{
+    operation: "DONE";
+}>;
+/**
+ * Preview who an unsaved version would reach, and which other published user
+ * experiences each of them also gets. Saves nothing.
+ * @param {Partial<UserExperienceVersion>} version The version to preview
+ * @param {string | undefined} id The user experience being edited, if saved
+ * @param {string} authToken Authorization token
+ * @returns {Promise<UserExperiencePreview>}
+ */
+export declare const previewUserExperience: (version: Partial<UserExperienceVersion>, id: string | undefined, authToken: string) => Promise<UserExperiencePreview>;
+/**
+ * "Check a person": their experiences plus, for each user experience, why it
+ * applies or not.
+ * @param {string} userId The person to check
+ * @param {string} authToken Authorization token
+ * @returns {Promise<UserExperienceExplanation>}
+ */
+export declare const explainUserExperiences: (userId: string, authToken: string) => Promise<UserExperienceExplanation>;
+/**
+ * Save the signed-in person's choice among their experiences. The server
+ * answers 400 unless it is one of theirs.
+ * @param {string} userExperienceId The user experience to use
+ * @param {string} authToken Authorization token
+ * @returns {Promise<void>}
+ */
+export declare const selectUserExperience: (userExperienceId: string, authToken: string) => Promise<void>;
+//# sourceMappingURL=userExperiences.d.ts.map

package/dist/esm/lib/userExperiences.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userExperiences.d.ts","sourceRoot":"","sources":["../../../src/lib/userExperiences.ts"],"names":[],"mappings":"AAsBA,sDAAsD;AACtD,MAAM,MAAM,YAAY,GACpB,SAAS,GACT,SAAS,GACT,SAAS,GACT,SAAS,GACT,WAAW,GACX,SAAS,CAAC;AAEd,mDAAmD;AACnD,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,GACP,MAAM,GACN,MAAM,GACN,QAAQ,CAAC;AAEb,iFAAiF;AACjF,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,MAAM,CAAC;AAE5C,yCAAyC;AACzC,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,KAAK,CAAC;IACvC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,YAAY,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,0DAA0D;AAC1D,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,YAAY,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;CAC5C;AAED,gDAAgD;AAChD,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,oBAAoB,EAAE,CAAC;IACpC,UAAU,EAAE;QAAE,IAAI,EAAE,SAAS,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAClD;AAED,kDAAkD;AAClD,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,OAAO,CAAA;KAAE,EAAE,CAAC;IACtD,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,uCAAuC;AACvC,MAAM,WAAW,iBAAiB;IAChC,gBAAgB,EAAE,MAAM,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,YAAY,CAAC;CAC1B;AAED,gEAAgE;AAChE,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,UAAU,GAAG,aAAa,GAAG,aAAa,CAAC;AAE7E,kFAAkF;AAClF,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,YAAY,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,aAAa,CAAC;IACvB,OAAO,EAAE,aAAa,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACvC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;IAC3C,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,wEAAwE;AACxE,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,qBAAqB,CAAC;IAC7B,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC,QAAQ,EAAE,OAAO,CAAC;IAClB,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,+CAA+C;AAC/C,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,YAAY,CAAC;IACzB,MAAM,EAAE,OAAO,GAAG,WAAW,GAAG,UAAU,CAAC;IAC3C,OAAO,EAAE,aAAa,CAAC;IACvB,OAAO,EAAE,aAAa,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,2FAA2F;IAC3F,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,gEAAgE;AAChE,MAAM,WAAW,qBAAqB;IACpC,gBAAgB,EAAE,MAAM,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,YAAY,CAAC;IACzB,OAAO,EAAE,OAAO,GAAG,cAAc,CAAC;IAClC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,0CAA0C;AAC1C,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,iBAAiB,EAAE,CAAA;KAAE,EAAE,CAAC;CACtE;AAED,mEAAmE;AACnE,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,iBAAiB,EAAE,CAAC;IACjC,QAAQ,EAAE,qBAAqB,EAAE,CAAC;CACnC;AAED;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,GACnC,WAAW,MAAM,KAChB,OAAO,CAAC,qBAAqB,CAG7B,CAAC;AAEJ;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAC9B,WAAW,MAAM,KAChB,OAAO,CAAC,sBAAsB,EAAE,CACqC,CAAC;AAEzE;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAC/B,MAAM,OAAO,CAAC,qBAAqB,CAAC,EACpC,WAAW,MAAM,KAChB,OAAO,CAAC,sBAAsB,CAC4C,CAAC;AAE9E;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAC5B,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,sBAAsB,CAK9B,CAAC;AAEJ;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,GAC/B,IAAI,MAAM,EACV,MAAM,OAAO,CAAC,qBAAqB,CAAC,EACpC,WAAW,MAAM,KAChB,OAAO,CAAC,sBAAsB,CAO9B,CAAC;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAChC,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,sBAAsB,CAO9B,CAAC;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,GACvC,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,sBAAsB,CAK9B,CAAC;AAEJ;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAC/B,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,CAM7B,CAAC;AAEJ;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,GAChC,SAAS,OAAO,CAAC,qBAAqB,CAAC,EACvC,IAAI,MAAM,GAAG,SAAS,EACtB,WAAW,MAAM,KAChB,OAAO,CAAC,qBAAqB,CAO7B,CAAC;AAEJ;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,GACjC,QAAQ,MAAM,EACd,WAAW,MAAM,KAChB,OAAO,CAAC,yBAAyB,CAKjC,CAAC;AAEJ;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,GAC/B,kBAAkB,MAAM,EACxB,WAAW,MAAM,KAChB,OAAO,CAAC,IAAI,CAOU,CAAC"}

package/dist/esm/lib/userExperiences.js

@@ -0,0 +1,106 @@
+import { client } from "./axiosClient.js";
+//
+// User experiences — /api/v1/userexperiences
+//
+// A user experience decides which of the platform's experiences (student,
+// teacher, channel, executive, new hire) a person gets, who it reaches, and
+// how it is labelled. Every call except selectUserExperience requires the
+// Manage user experiences permission; selectUserExperience acts on the signed-in
+// person only. Ids are strings and dates ISO strings over HTTP.
+//
+const BASE = `/api/v1/userexperiences`;
+const call = (request) => new Promise((resolve, reject) => {
+    request
+        .then((response) => resolve(response.data))
+        .catch((error) => reject(error));
+});
+/**
+ * Get the settings catalog and the label terms.
+ * @param {string} authToken Authorization token
+ * @returns {Promise<UserExperienceCatalog>}
+ */
+export const getUserExperienceCatalog = (authToken) => call(client.get(`${BASE}/catalog`, { headers: { authorization: authToken } }));
+/**
+ * List the tenant's user experiences with their status and reach.
+ * @param {string} authToken Authorization token
+ * @returns {Promise<UserExperienceListItem[]>}
+ */
+export const listUserExperiences = (authToken) => call(client.post(BASE, {}, { headers: { authorization: authToken } }));
+/**
+ * Create a user experience as a draft.
+ * @param {Partial<UserExperienceVersion>} data The draft content
+ * @param {string} authToken Authorization token
+ * @returns {Promise<UserExperienceDocument>}
+ */
+export const createUserExperience = (data, authToken) => call(client.put(BASE, { data }, { headers: { authorization: authToken } }));
+/**
+ * Get one user experience with its draft and published versions.
+ * @param {string} id The user experience id
+ * @param {string} authToken Authorization token
+ * @returns {Promise<UserExperienceDocument>}
+ */
+export const getUserExperience = (id, authToken) => call(client.get(`${BASE}/${encodeURIComponent(id)}`, {
+    headers: { authorization: authToken },
+}));
+/**
+ * Update the draft of a user experience.
+ * @param {string} id The user experience id
+ * @param {Partial<UserExperienceVersion>} data The fields to change
+ * @param {string} authToken Authorization token
+ * @returns {Promise<UserExperienceDocument>}
+ */
+export const updateUserExperience = (id, data, authToken) => call(client.post(`${BASE}/update`, { id, data }, { headers: { authorization: authToken } }));
+/**
+ * Publish the draft of a user experience.
+ * @param {string} id The user experience id
+ * @param {string} authToken Authorization token
+ * @returns {Promise<UserExperienceDocument>}
+ */
+export const publishUserExperience = (id, authToken) => call(client.post(`${BASE}/publish/${encodeURIComponent(id)}`, {}, { headers: { authorization: authToken } }));
+/**
+ * Discard the unpublished changes of a user experience.
+ * @param {string} id The user experience id
+ * @param {string} authToken Authorization token
+ * @returns {Promise<UserExperienceDocument>}
+ */
+export const discardUserExperienceChanges = (id, authToken) => call(client.get(`${BASE}/discard/${encodeURIComponent(id)}`, {
+    headers: { authorization: authToken },
+}));
+/**
+ * Delete a user experience.
+ * @param {string} id The user experience id
+ * @param {string} authToken Authorization token
+ * @returns {Promise<{ operation: "DONE" }>}
+ */
+export const deleteUserExperience = (id, authToken) => call(client.delete(BASE, {
+    data: { id },
+    headers: { authorization: authToken },
+}));
+/**
+ * Preview who an unsaved version would reach, and which other published user
+ * experiences each of them also gets. Saves nothing.
+ * @param {Partial<UserExperienceVersion>} version The version to preview
+ * @param {string | undefined} id The user experience being edited, if saved
+ * @param {string} authToken Authorization token
+ * @returns {Promise<UserExperiencePreview>}
+ */
+export const previewUserExperience = (version, id, authToken) => call(client.post(`${BASE}/preview`, id === undefined ? { version } : { id, version }, { headers: { authorization: authToken } }));
+/**
+ * "Check a person": their experiences plus, for each user experience, why it
+ * applies or not.
+ * @param {string} userId The person to check
+ * @param {string} authToken Authorization token
+ * @returns {Promise<UserExperienceExplanation>}
+ */
+export const explainUserExperiences = (userId, authToken) => call(client.get(`${BASE}/explain/${encodeURIComponent(userId)}`, {
+    headers: { authorization: authToken },
+}));
+/**
+ * Save the signed-in person's choice among their experiences. The server
+ * answers 400 unless it is one of theirs.
+ * @param {string} userExperienceId The user experience to use
+ * @param {string} authToken Authorization token
+ * @returns {Promise<void>}
+ */
+export const selectUserExperience = (userExperienceId, authToken) => call(client.post(`${BASE}/select`, { userExperienceId }, { headers: { authorization: authToken } })).then(() => undefined);
+//# sourceMappingURL=userExperiences.js.map

package/dist/esm/lib/userExperiences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userExperiences.js","sourceRoot":"","sources":["../../../src/lib/userExperiences.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,0EAA0E;AAC1E,4EAA4E;AAC5E,0EAA0E;AAC1E,iFAAiF;AACjF,gEAAgE;AAChE,EAAE;AAEF,MAAM,IAAI,GAAG,yBAAyB,CAAC;AAEvC,MAAM,IAAI,GAAG,CAAI,OAAkC,EAAc,EAAE,CACjE,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;IAC9B,OAAO;SACJ,IAAI,CAAC,CAAC,QAA0B,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;SAC5D,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AACjD,CAAC,CAAC,CAAC;AAkIL;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,SAAiB,EACe,EAAE,CAClC,IAAI,CACF,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,UAAU,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAAC,CACzE,CAAC;AAEJ;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,SAAiB,EACkB,EAAE,CACrC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC;AAEzE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,IAAoC,EACpC,SAAiB,EACgB,EAAE,CACnC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC;AAE9E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,EAAU,EACV,SAAiB,EACgB,EAAE,CACnC,IAAI,CACF,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,IAAI,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE;IAC9C,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;CACtC,CAAC,CACH,CAAC;AAEJ;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,EAAU,EACV,IAAoC,EACpC,SAAiB,EACgB,EAAE,CACnC,IAAI,CACF,MAAM,CAAC,IAAI,CACT,GAAG,IAAI,SAAS,EAChB,EAAE,EAAE,EAAE,IAAI,EAAE,EACZ,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CACF,CAAC;AAEJ;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,EAAU,EACV,SAAiB,EACgB,EAAE,CACnC,IAAI,CACF,MAAM,CAAC,IAAI,CACT,GAAG,IAAI,YAAY,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC3C,EAAE,EACF,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CACF,CAAC;AAEJ;;;;;GAKG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,EAAU,EACV,SAAiB,EACgB,EAAE,CACnC,IAAI,CACF,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,YAAY,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE;IACtD,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;CACtC,CAAC,CACH,CAAC;AAEJ;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,EAAU,EACV,SAAiB,EACe,EAAE,CAClC,IAAI,CACF,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;IAClB,IAAI,EAAE,EAAE,EAAE,EAAE;IACZ,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;CACtC,CAAC,CACH,CAAC;AAEJ;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,OAAuC,EACvC,EAAsB,EACtB,SAAiB,EACe,EAAE,CAClC,IAAI,CACF,MAAM,CAAC,IAAI,CACT,GAAG,IAAI,UAAU,EACjB,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,EAChD,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CACF,CAAC;AAEJ;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,MAAc,EACd,SAAiB,EACmB,EAAE,CACtC,IAAI,CACF,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,YAAY,kBAAkB,CAAC,MAAM,CAAC,EAAE,EAAE;IAC1D,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;CACtC,CAAC,CACH,CAAC;AAEJ;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,gBAAwB,EACxB,SAAiB,EACF,EAAE,CACjB,IAAI,CACF,MAAM,CAAC,IAAI,CACT,GAAG,IAAI,SAAS,EAChB,EAAE,gBAAgB,EAAE,EACpB,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CACF,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC"}

package/dist/esm/lib/users.d.ts

@@ -1,3 +1,4 @@
+import type { ExperienceSummary } from "./userExperiences.js";
 /**
  * Get the applications the requesting user is entitled to. Returns the
  * intersection of the tenant's licensed applications and the user's group
@@ -9,6 +10,17 @@
 export declare const getUserApplications: (token: string) => Promise<{
     applications: string[];
 }>;
+/** A personal API key as listed: never carries the key itself. */
+export interface APITokenView {
+    _id: string;
+    name: string;
+    type: string;
+    createdAt: string;
+    expirationDate: string;
+    lastUsedAt: string | null;
+    scopes: string[];
+    tokenHint: string | null;
+}
 /**
  * Add a new API Token
  * @param {string} name Name of the token
@@ -19,9 +31,13 @@ export declare const getUserApplications: (token: string) => Promise<{
  *   id must be a permission the caller currently holds; the server answers 400
  *   "Invalid token scope" otherwise. An empty list is rejected too — the only
  *   way to get full access is to not ask for a scope.
- * @returns {Promise<object>}
+ * @returns {Promise<APITokenView & { token: string }>} The new key's view plus
+ *   `token`, the key itself. It is returned this once and never again: the
+ *   server keeps only a hint, so show or store it now.
  */
-export declare const addAPIToken: (name: string, expiration: Date, token: string, scopes?: string[] | null) => Promise<object>;
+export declare const addAPIToken: (name: string, expiration: Date, token: string, scopes?: string[] | null) => Promise<APITokenView & {
+    token: string;
+}>;
 /**
  * Confirm email address
  * @param {string} validationCode The code was provided to the user in advance by email
@@ -65,11 +81,11 @@ export declare const createAccount: (email: string, firstName: string, lastName:
 export declare const createUserAccount: (email: string, firstName: string, lastName: string, password: string, token: string) => Promise<object>;
 /**
  * Delete an existing API token
- * @param {string} token Expiration date of the token
+ * @param {string} id The record id (`_id`) of the API token, as listed by getAPITokens
  * @param {string} authToken Authorization token
- * @returns {Promise<string>}
+ * @returns {Promise<string>} The id that was deleted
  */
-export declare const deleteAPIToken: (token: string, authToken: string) => Promise<string>;
+export declare const deleteAPIToken: (id: string, authToken: string) => Promise<string>;
 /**
  * Delete existing users
  * @param {string[]} userIds The ID of the users to be deleted
@@ -78,11 +94,11 @@ export declare const deleteAPIToken: (token: string, authToken: string) => Promi
  */
 export declare const deleteUsers: (userIds: string[], token: string) => Promise<object>;
 /**
- * Get all the API tokens
+ * Get all the API tokens (views: the key itself is never returned)
  * @param {string} token Authorization token
- * @returns {Promise<object>}
+ * @returns {Promise<APITokenView[]>}
  */
-export declare const getAPITokens: (token: string) => Promise<object>;
+export declare const getAPITokens: (token: string) => Promise<APITokenView[]>;
 /**
  * Get the specified user account by Id. It returns a promise
  * @param {string} id Id of the user for which information is being requested
@@ -106,6 +122,16 @@ export declare const getUserInformation: (userId: string, category: string, toke
  * @returns {Promise<object>}
  */
 export declare const getUsers: (filter: object, fields: string[], token: string) => Promise<object>;
+/**
+ * Get the list of users, each with the user experiences they get. Only callers
+ * with Manage users receive `experiences`.
+ * @param {object} filter Filter to select the users. Ex: {firstName : "John"}
+ * @param {string} token Authorization token
+ * @returns {Promise<Array<Record<string, unknown> & { experiences: ExperienceSummary[] }>>}
+ */
+export declare const getUsersWithExperiences: (filter: object, token: string) => Promise<(Record<string, unknown> & {
+    experiences: ExperienceSummary[];
+})[]>;
 /**
  * Invite other users to join the same account
  * @param {string[]} invitees List of emails of the invitees

package/dist/esm/lib/users.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/lib/users.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,GAC9B,OAAO,MAAM,KACZ,OAAO,CAAC;IAAE,YAAY,EAAE,MAAM,EAAE,CAAA;CAAE,CAapC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,WAAW,GACtB,MAAM,MAAM,EACZ,YAAY,IAAI,EAChB,OAAO,MAAM,EACb,SAAQ,MAAM,EAAE,GAAG,IAAW,KAC7B,OAAO,CAAC,MAAM,CA4BhB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,gBAAgB,MAAM,KAAG,OAAO,CAAC,IAAI,CAiBxE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GACvB,gBAAgB,MAAM,EACtB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAoBhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,GACnC,aAAa,MAAM,EACnB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAoBhB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa,GACxB,OAAO,MAAM,EACb,WAAW,MAAM,EACjB,UAAU,MAAM,EAChB,UAAU,MAAM,EAChB,SAAS,MAAM,EACf,YAAY,MAAM,KACjB,OAAO,CAAC,MAAM,CA8BhB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,GAC5B,OAAO,MAAM,EACb,WAAW,MAAM,EACjB,UAAU,MAAM,EAChB,UAAU,MAAM,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CA4BhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GACzB,OAAO,MAAM,EACb,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GACtB,SAAS,MAAM,EAAE,EACjB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,MAAM,KAAG,OAAO,CAAC,MAAM,CAa1D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,IAAI,MAAM,EAAE,OAAO,MAAM,KAAG,OAAO,CAAC,MAAM,CAiBrE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,GAC7B,QAAQ,MAAM,EACd,UAAU,MAAM,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,GACnB,QAAQ,MAAM,EACd,QAAQ,MAAM,EAAE,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAiBhB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,GACtB,UAAU,MAAM,EAAE,EAClB,SAAS,MAAM,EACf,QAAQ,MAAM,EACd,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAmBhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,KAAK,GAAI,OAAO,MAAM,EAAE,UAAU,MAAM,KAAG,OAAO,CAAC,MAAM,CAerE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAC5B,MAAM,MAAM,EACZ,cAAc,MAAM,EACpB,aAAa,MAAM,KAClB,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,MAAM,GAAI,OAAO,MAAM,KAAG,OAAO,CAAC,MAAM,CAiBpD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,eAAe,MAAM,KAAG,OAAO,CAAC,MAAM,CAalE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GACzB,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAoBhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,GACjC,UAAU,MAAM,EAAE,EAClB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAiBhB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,GACxB,OAAO,MAAM,EACb,MAAM,MAAM,EACZ,UAAU,MAAM,KACf,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,GACpC,OAAO,MAAM,EACb,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAoBhB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,6BAA6B,GACxC,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAiBhB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,GAC7B,QAAQ,MAAM,EACd,UAAU,MAAM,EAChB,MAAM,MAAM,EACZ,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAiBhB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,GAC1B,OAAO,MAAM,EACb,kBAAkB,MAAM,EACxB,UAAU,MAAM,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAsBhB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAC3B,QAAQ,MAAM,EACd,QAAQ,MAAM,EAAE,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAqBhB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,GAC7B,UAAU,MAAM,EAChB,aAAa,MAAM,EACnB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAqBhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,GACpC,OAAO,MAAM,EACb,MAAM,MAAM,KACX,OAAO,CAAC,MAAM,CAkBhB,CAAC"}
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/lib/users.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAE9D;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,GAC9B,OAAO,MAAM,KACZ,OAAO,CAAC;IAAE,YAAY,EAAE,MAAM,EAAE,CAAA;CAAE,CAapC,CAAC;AAEF,kEAAkE;AAClE,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,WAAW,GACtB,MAAM,MAAM,EACZ,YAAY,IAAI,EAChB,OAAO,MAAM,EACb,SAAQ,MAAM,EAAE,GAAG,IAAW,KAC7B,OAAO,CAAC,YAAY,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CA4B1C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,gBAAgB,MAAM,KAAG,OAAO,CAAC,IAAI,CAiBxE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GACvB,gBAAgB,MAAM,EACtB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAoBhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,GACnC,aAAa,MAAM,EACnB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAoBhB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,aAAa,GACxB,OAAO,MAAM,EACb,WAAW,MAAM,EACjB,UAAU,MAAM,EAChB,UAAU,MAAM,EAChB,SAAS,MAAM,EACf,YAAY,MAAM,KACjB,OAAO,CAAC,MAAM,CA8BhB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,GAC5B,OAAO,MAAM,EACb,WAAW,MAAM,EACjB,UAAU,MAAM,EAChB,UAAU,MAAM,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CA4BhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GACzB,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GACtB,SAAS,MAAM,EAAE,EACjB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,MAAM,KAAG,OAAO,CAAC,YAAY,EAAE,CAalE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,IAAI,MAAM,EAAE,OAAO,MAAM,KAAG,OAAO,CAAC,MAAM,CAiBrE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,GAC7B,QAAQ,MAAM,EACd,UAAU,MAAM,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,GACnB,QAAQ,MAAM,EACd,QAAQ,MAAM,EAAE,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAiBhB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,GAClC,QAAQ,MAAM,EACd,OAAO,MAAM,KACZ,OAAO,CACR,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IAAE,WAAW,EAAE,iBAAiB,EAAE,CAAA;CAAE,CAAC,EAAE,CAkBnE,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,GACtB,UAAU,MAAM,EAAE,EAClB,SAAS,MAAM,EACf,QAAQ,MAAM,EACd,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAmBhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,KAAK,GAAI,OAAO,MAAM,EAAE,UAAU,MAAM,KAAG,OAAO,CAAC,MAAM,CAerE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAC5B,MAAM,MAAM,EACZ,cAAc,MAAM,EACpB,aAAa,MAAM,KAClB,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,MAAM,GAAI,OAAO,MAAM,KAAG,OAAO,CAAC,MAAM,CAiBpD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,eAAe,MAAM,KAAG,OAAO,CAAC,MAAM,CAalE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GACzB,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAoBhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,GACjC,UAAU,MAAM,EAAE,EAClB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAiBhB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,GACxB,OAAO,MAAM,EACb,MAAM,MAAM,EACZ,UAAU,MAAM,KACf,OAAO,CAAC,MAAM,CAgBhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,GACpC,OAAO,MAAM,EACb,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAoBhB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,6BAA6B,GACxC,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAiBhB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,GAC7B,QAAQ,MAAM,EACd,UAAU,MAAM,EAChB,MAAM,MAAM,EACZ,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAiBhB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,GAC1B,OAAO,MAAM,EACb,kBAAkB,MAAM,EACxB,UAAU,MAAM,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAsBhB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAC3B,QAAQ,MAAM,EACd,QAAQ,MAAM,EAAE,EAChB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAqBhB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,GAC7B,UAAU,MAAM,EAChB,aAAa,MAAM,EACnB,OAAO,MAAM,KACZ,OAAO,CAAC,MAAM,CAqBhB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,GACpC,OAAO,MAAM,EACb,MAAM,MAAM,KACX,OAAO,CAAC,MAAM,CAkBhB,CAAC"}

package/dist/esm/lib/users.js

@@ -31,7 +31,9 @@ export const getUserApplications = (token) => {
  *   id must be a permission the caller currently holds; the server answers 400
  *   "Invalid token scope" otherwise. An empty list is rejected too — the only
  *   way to get full access is to not ask for a scope.
- * @returns {Promise<object>}
+ * @returns {Promise<APITokenView & { token: string }>} The new key's view plus
+ *   `token`, the key itself. It is returned this once and never again: the
+ *   server keeps only a hint, so show or store it now.
  */
 export const addAPIToken = (name, expiration, token, scopes = null) => {
     return new Promise((resolve, reject) => {
@@ -204,21 +206,21 @@ export const createUserAccount = (email, firstName, lastName, password, token) =
 };
 /**
  * Delete an existing API token
- * @param {string} token Expiration date of the token
+ * @param {string} id The record id (`_id`) of the API token, as listed by getAPITokens
  * @param {string} authToken Authorization token
- * @returns {Promise<string>}
+ * @returns {Promise<string>} The id that was deleted
  */
-export const deleteAPIToken = (token, authToken) => {
+export const deleteAPIToken = (id, authToken) => {
     return new Promise((resolve, reject) => {
         const deleteTokenRequest = client.delete(`/api/v1/users/user/token`, {
             headers: { authorization: authToken },
             data: {
-                token: token,
+                id: id,
             },
         });
         deleteTokenRequest
             .then(() => {
-            resolve(token);
+            resolve(id);
         })
             .catch((error) => {
             reject(error);
@@ -249,9 +251,9 @@ export const deleteUsers = (userIds, token) => {
     });
 };
 /**
- * Get all the API tokens
+ * Get all the API tokens (views: the key itself is never returned)
  * @param {string} token Authorization token
- * @returns {Promise<object>}
+ * @returns {Promise<APITokenView[]>}
  */
 export const getAPITokens = (token) => {
     return new Promise((resolve, reject) => {
@@ -338,6 +340,31 @@ export const getUsers = (filter, fields, token) => {
         });
     });
 };
+/**
+ * Get the list of users, each with the user experiences they get. Only callers
+ * with Manage users receive `experiences`.
+ * @param {object} filter Filter to select the users. Ex: {firstName : "John"}
+ * @param {string} token Authorization token
+ * @returns {Promise<Array<Record<string, unknown> & { experiences: ExperienceSummary[] }>>}
+ */
+export const getUsersWithExperiences = (filter, token) => {
+    return new Promise((resolve, reject) => {
+        const requestData = {
+            filter: filter,
+            include: ["experiences"],
+        };
+        const request = client.post(`/api/v1/users/`, requestData, {
+            headers: { authorization: token },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
 /**
  * Invite other users to join the same account
  * @param {string[]} invitees List of emails of the invitees