@stackfactor/client-api 1.9.2 → 1.10.0

package/dist/cjs/lib/metric.js

@@ -0,0 +1,170 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMetricRelatedPolicies = exports.getMetricRelatedStandards = exports.getMetricRelatedRequirements = exports.getMetricRelatedControls = exports.watchMetric = exports.setMetricInformationFromTemplate = exports.getMetricTemplateUpdates = exports.createMetricsFromTemplates = exports.setMetricInformation = exports.publishMetric = exports.getMetricList = exports.getMetricInformationById = exports.discardMetricChanges = exports.deleteMetric = exports.createMetric = void 0;
+const axiosClient_js_1 = require("./axiosClient.js");
+/**
+ * Create metric and set information
+ * @param {Object} data
+ * @param {String} token Authorization token
+ * @returns {Promise<MetricRecord>}
+ */
+const createMetric = (data, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.put("/api/v1/shield/metrics", { data }, { headers: { authorization: token } }));
+exports.createMetric = createMetric;
+/**
+ * Delete metric
+ * @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<MetricRecord>}
+ */
+const deleteMetric = (id, comments, token) => {
+    const data = { id };
+    if (comments)
+        data.comments = comments;
+    return (0, axiosClient_js_1.request)(axiosClient_js_1.client.delete("/api/v1/shield/metrics/", { headers: { authorization: token }, data }));
+};
+exports.deleteMetric = deleteMetric;
+/**
+ * Discard the metric draft changes
+ * @param {String} id The id of the record to be discarded
+ * @param {String} token Authorization token
+ * @returns {Promise<MetricRecord>}
+ */
+const discardMetricChanges = (id, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.get(`/api/v1/shield/metrics/discard/${id}`, { headers: { authorization: token } }));
+exports.discardMetricChanges = discardMetricChanges;
+/**
+ * Get metric 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<MetricRecord | null>}
+ */
+const getMetricInformationById = (id, version, returnNullIfVersionNotFound, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.get(`/api/v1/shield/metrics/${id}/${version}/${returnNullIfVersionNotFound}`, {
+    headers: { authorization: token },
+}));
+exports.getMetricInformationById = getMetricInformationById;
+/**
+ * Get metric list
+ * @param {Array<String>} filter The filter used to select the records
+ * @param {String} version The version to be retrieved
+ * @param {Boolean} includeDeleted If true it will return deleted records as well
+ * @param {Boolean} returnDefaultIfVersionNotAvailable Return the default version if published not available
+ * @param {String} details The level of detail to return ("ID", "NAME", "DEFAULT")
+ * @param {String} token Authorization token
+ * @returns {Promise<MetricRecord[]>}
+ */
+const getMetricList = (filter, version, includeDeleted, returnDefaultIfVersionNotAvailable, details, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.post("/api/v1/shield/metrics", { includeDeleted, details, returnDefaultIfVersionNotAvailable, version, filter }, { headers: { authorization: token } }));
+exports.getMetricList = getMetricList;
+/**
+ * Publish metric
+ * @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<MetricRecord>}
+ */
+const publishMetric = (id, comments, token) => {
+    const data = {};
+    if (comments)
+        data.comments = comments;
+    return (0, axiosClient_js_1.request)(axiosClient_js_1.client.post(`/api/v1/shield/metrics/publish/${id}`, data, { headers: { authorization: token } }));
+};
+exports.publishMetric = publishMetric;
+/**
+ * Set metric 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<MetricRecord>}
+ */
+const setMetricInformation = (id, data, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.post(`/api/v1/shield/metrics/update`, { data, id }, { headers: { authorization: token } }));
+exports.setMetricInformation = setMetricInformation;
+/**
+ * Create metrics from templates
+ * @param {Array<String>} templateIds
+ * @param {String} token Authorization token
+ * @returns {Promise<MetricRecord[]>}
+ */
+const createMetricsFromTemplates = (templateIds, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.put(`/api/v1/shield/metrics/createfromtemplate/`, { templateIds }, {
+    headers: { authorization: token },
+}));
+exports.createMetricsFromTemplates = createMetricsFromTemplates;
+/**
+ * The differences between a metric and its template, per field
+ * @param {String} id The id of the metric
+ * @param {String} token Authorization token
+ * @returns {Promise<TemplateFieldDiff[]>}
+ */
+const getMetricTemplateUpdates = (id, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.get(`/api/v1/shield/metrics/templateupdates/${id}`, {
+    headers: { authorization: token },
+}));
+exports.getMetricTemplateUpdates = getMetricTemplateUpdates;
+/**
+ * Set the metric information from template
+ * @param {String} id The id of the metric to be updated
+ * @param {TemplateMergeSelection} data The diff with `merge` set on the accepted changes
+ * @param {String} token Authorization token
+ * @returns {Promise<FrameworkRecordSummary>}
+ */
+const setMetricInformationFromTemplate = (id, data, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.post(`/api/v1/shield/metrics/updatefromtemplate/`, { data, id }, { headers: { authorization: token } }));
+exports.setMetricInformationFromTemplate = setMetricInformationFromTemplate;
+/**
+ * Watch metric
+ * @param {String} id The id of the metric
+ * @param {Boolean} watch Set to true or false
+ * @param {String} token Authorization token
+ * @returns {Promise<MetricRecord>}
+ */
+const watchMetric = (id, watch, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.post(`/api/v1/shield/metrics/watch`, { id, watch }, {
+    headers: { authorization: token },
+}));
+exports.watchMetric = watchMetric;
+/**
+ * Get the metric related controls
+ * @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[]>}
+ */
+const getMetricRelatedControls = (id, details, version, includeDeleted, returnDefaultIfVersionNotAvailable, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.post(`/api/v1/shield/metrics/controls/${id}`, { details, version, includeDeleted, returnDefaultIfVersionNotAvailable }, { headers: { authorization: token } }));
+exports.getMetricRelatedControls = getMetricRelatedControls;
+/**
+ * Get the metric related requirements
+ * @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[]>}
+ */
+const getMetricRelatedRequirements = (id, details, version, includeDeleted, returnDefaultIfVersionNotAvailable, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.post(`/api/v1/shield/metrics/requirements/${id}`, { details, version, includeDeleted, returnDefaultIfVersionNotAvailable }, { headers: { authorization: token } }));
+exports.getMetricRelatedRequirements = getMetricRelatedRequirements;
+/**
+ * Get the metric related standards
+ * @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[]>}
+ */
+const getMetricRelatedStandards = (id, details, version, includeDeleted, returnDefaultIfVersionNotAvailable, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.post(`/api/v1/shield/metrics/standards/${id}`, { details, version, includeDeleted, returnDefaultIfVersionNotAvailable }, { headers: { authorization: token } }));
+exports.getMetricRelatedStandards = getMetricRelatedStandards;
+/**
+ * Get the metric related policies
+ * @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[]>}
+ */
+const getMetricRelatedPolicies = (id, details, version, includeDeleted, returnDefaultIfVersionNotAvailable, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.post(`/api/v1/shield/metrics/policies/${id}`, { details, version, includeDeleted, returnDefaultIfVersionNotAvailable }, { headers: { authorization: token } }));
+exports.getMetricRelatedPolicies = getMetricRelatedPolicies;
+//# sourceMappingURL=metric.js.map

package/dist/cjs/lib/metric.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metric.js","sourceRoot":"","sources":["../../../src/lib/metric.ts"],"names":[],"mappings":";;;AAAA,qDAAmD;AAkDnD;;;;;GAKG;AACI,MAAM,YAAY,GAAG,CAAC,IAA4B,EAAE,KAAa,EAAyB,EAAE,CACjG,IAAA,wBAAO,EAAe,uBAAM,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;AADlG,QAAA,YAAY,gBACsF;AAE/G;;;;;;GAMG;AACI,MAAM,YAAY,GAAG,CAAC,EAAU,EAAE,QAAgB,EAAE,KAAa,EAAyB,EAAE;IACjG,MAAM,IAAI,GAAsC,EAAE,EAAE,EAAE,CAAC;IACvD,IAAI,QAAQ;QAAE,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IACvC,OAAO,IAAA,wBAAO,EACZ,uBAAM,CAAC,MAAM,CAAC,yBAAyB,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,CACtF,CAAC;AACJ,CAAC,CAAC;AANW,QAAA,YAAY,gBAMvB;AAEF;;;;;GAKG;AACI,MAAM,oBAAoB,GAAG,CAAC,EAAU,EAAE,KAAa,EAAyB,EAAE,CACvF,IAAA,wBAAO,EACL,uBAAM,CAAC,GAAG,CAAC,kCAAkC,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CAC1F,CAAC;AAHS,QAAA,oBAAoB,wBAG7B;AAEJ;;;;;;;GAOG;AACI,MAAM,wBAAwB,GAAG,CACtC,EAAU,EACV,OAAe,EACf,2BAAoC,EACpC,KAAa,EACiB,EAAE,CAChC,IAAA,wBAAO,EACL,uBAAM,CAAC,GAAG,CAAC,0BAA0B,EAAE,IAAI,OAAO,IAAI,2BAA2B,EAAE,EAAE;IACnF,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CAAC,CACH,CAAC;AAVS,QAAA,wBAAwB,4BAUjC;AAEJ;;;;;;;;;GASG;AACI,MAAM,aAAa,GAAG,CAC3B,MAAgB,EAChB,OAAe,EACf,cAAuB,EACvB,kCAA2C,EAC3C,OAAe,EACf,KAAa,EACY,EAAE,CAC3B,IAAA,wBAAO,EACL,uBAAM,CAAC,IAAI,CACT,wBAAwB,EACxB,EAAE,cAAc,EAAE,OAAO,EAAE,kCAAkC,EAAE,OAAO,EAAE,MAAM,EAAE,EAChF,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CACtC,CACF,CAAC;AAdS,QAAA,aAAa,iBActB;AAEJ;;;;;;GAMG;AACI,MAAM,aAAa,GAAG,CAAC,EAAU,EAAE,QAAgB,EAAE,KAAa,EAAyB,EAAE;IAClG,MAAM,IAAI,GAA0B,EAAE,CAAC;IACvC,IAAI,QAAQ;QAAE,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IACvC,OAAO,IAAA,wBAAO,EACZ,uBAAM,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CACjG,CAAC;AACJ,CAAC,CAAC;AANW,QAAA,aAAa,iBAMxB;AAEF;;;;;;GAMG;AACI,MAAM,oBAAoB,GAAG,CAClC,EAAU,EACV,IAA4B,EAC5B,KAAa,EACU,EAAE,CACzB,IAAA,wBAAO,EACL,uBAAM,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CAClG,CAAC;AAPS,QAAA,oBAAoB,wBAO7B;AAEJ;;;;;GAKG;AACI,MAAM,0BAA0B,GAAG,CACxC,WAAqB,EACrB,KAAa,EACY,EAAE,CAC3B,IAAA,wBAAO,EACL,uBAAM,CAAC,GAAG,CAAC,4CAA4C,EAAE,EAAE,WAAW,EAAE,EAAE;IACxE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CAAC,CACH,CAAC;AARS,QAAA,0BAA0B,8BAQnC;AAEJ;;;;;GAKG;AACI,MAAM,wBAAwB,GAAG,CACtC,EAAU,EACV,KAAa,EACiB,EAAE,CAChC,IAAA,wBAAO,EACL,uBAAM,CAAC,GAAG,CAAC,0CAA0C,EAAE,EAAE,EAAE;IACzD,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CAAC,CACH,CAAC;AARS,QAAA,wBAAwB,4BAQjC;AAEJ;;;;;;GAMG;AACI,MAAM,gCAAgC,GAAG,CAC9C,EAAU,EACV,IAA4B,EAC5B,KAAa,EACoB,EAAE,CACnC,IAAA,wBAAO,EACL,uBAAM,CAAC,IAAI,CACT,4CAA4C,EAC5C,EAAE,IAAI,EAAE,EAAE,EAAE,EACZ,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CACtC,CACF,CAAC;AAXS,QAAA,gCAAgC,oCAWzC;AAEJ;;;;;;GAMG;AACI,MAAM,WAAW,GAAG,CACzB,EAAU,EACV,KAAc,EACd,KAAa,EACU,EAAE,CACzB,IAAA,wBAAO,EACL,uBAAM,CAAC,IAAI,CAAC,8BAA8B,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE;IACzD,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CAAC,CACH,CAAC;AATS,QAAA,WAAW,eASpB;AAEJ;;;;;;;;;GASG;AACI,MAAM,wBAAwB,GAAG,CACtC,EAAU,EACV,OAAe,EACf,OAAe,EACf,cAAuB,EACvB,kCAA2C,EAC3C,KAAa,EACiB,EAAE,CAChC,IAAA,wBAAO,EACL,uBAAM,CAAC,IAAI,CACT,mCAAmC,EAAE,EAAE,EACvC,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,kCAAkC,EAAE,EACxE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CACtC,CACF,CAAC;AAdS,QAAA,wBAAwB,4BAcjC;AAEJ;;;;;;;;;GASG;AACI,MAAM,4BAA4B,GAAG,CAC1C,EAAU,EACV,OAAe,EACf,OAAe,EACf,cAAuB,EACvB,kCAA2C,EAC3C,KAAa,EACiB,EAAE,CAChC,IAAA,wBAAO,EACL,uBAAM,CAAC,IAAI,CACT,uCAAuC,EAAE,EAAE,EAC3C,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,kCAAkC,EAAE,EACxE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CACtC,CACF,CAAC;AAdS,QAAA,4BAA4B,gCAcrC;AAEJ;;;;;;;;;GASG;AACI,MAAM,yBAAyB,GAAG,CACvC,EAAU,EACV,OAAe,EACf,OAAe,EACf,cAAuB,EACvB,kCAA2C,EAC3C,KAAa,EACiB,EAAE,CAChC,IAAA,wBAAO,EACL,uBAAM,CAAC,IAAI,CACT,oCAAoC,EAAE,EAAE,EACxC,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,kCAAkC,EAAE,EACxE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CACtC,CACF,CAAC;AAdS,QAAA,yBAAyB,6BAclC;AAEJ;;;;;;;;;GASG;AACI,MAAM,wBAAwB,GAAG,CACtC,EAAU,EACV,OAAe,EACf,OAAe,EACf,cAAuB,EACvB,kCAA2C,EAC3C,KAAa,EACiB,EAAE,CAChC,IAAA,wBAAO,EACL,uBAAM,CAAC,IAAI,CACT,mCAAmC,EAAE,EAAE,EACvC,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,kCAAkC,EAAE,EACxE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CACtC,CACF,CAAC;AAdS,QAAA,wBAAwB,4BAcjC"}

package/dist/cjs/lib/metricTemplate.d.ts

@@ -0,0 +1,119 @@
+import type { MetricContent, RelatedRecordOrId } from "./metric.js";
+/** A metric template as returned by the server; sides may be absent. */
+export interface MetricTemplateRecord {
+    _id: string;
+    draft?: MetricContent;
+    published?: MetricContent;
+    tags?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+/**
+ * Create metric template and set information
+ * @param {Object} data
+ * @param {String} token Authorization token
+ * @returns {Promise<MetricTemplateRecord>}
+ */
+export declare const createMetricTemplate: (data: Partial<MetricContent>, token: string) => Promise<MetricTemplateRecord>;
+/**
+ * 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 declare const deleteMetricTemplate: (id: string, comments: string, token: string) => Promise<MetricTemplateRecord>;
+/**
+ * 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 declare const discardMetricTemplateChanges: (id: string, token: string) => Promise<MetricTemplateRecord>;
+/**
+ * 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 declare const getMetricTemplateInformationById: (id: string, version: string, returnNullIfVersionNotFound: boolean, token: string) => Promise<MetricTemplateRecord | null>;
+/**
+ * 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 declare const getMetricTemplateList: (filter: string[], version: string, includeDeleted: boolean, details: string, token: string) => Promise<MetricTemplateRecord[]>;
+/**
+ * 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 declare const publishMetricTemplate: (id: string, comments: string, token: string) => Promise<MetricTemplateRecord>;
+/**
+ * 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 declare const setMetricTemplateInformation: (id: string, data: Partial<MetricContent>, token: string) => Promise<MetricTemplateRecord>;
+/**
+ * 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 declare const setMetricTemplateTags: (id: string, tags: Record<string, unknown>, token: string) => Promise<MetricTemplateRecord>;
+/**
+ * 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 declare const getMetricTemplateRelatedControlTemplates: (id: string, details: string, version: string, includeDeleted: boolean, returnDefaultIfVersionNotAvailable: boolean, token: string) => Promise<RelatedRecordOrId[]>;
+/**
+ * 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 declare const getMetricTemplateRelatedRequirementTemplates: (id: string, details: string, version: string, includeDeleted: boolean, returnDefaultIfVersionNotAvailable: boolean, token: string) => Promise<RelatedRecordOrId[]>;
+/**
+ * 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 declare const getMetricTemplateRelatedStandardTemplates: (id: string, details: string, version: string, includeDeleted: boolean, returnDefaultIfVersionNotAvailable: boolean, token: string) => Promise<RelatedRecordOrId[]>;
+/**
+ * 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 declare const getMetricTemplateRelatedPolicyTemplates: (id: string, details: string, version: string, includeDeleted: boolean, returnDefaultIfVersionNotAvailable: boolean, token: string) => Promise<RelatedRecordOrId[]>;
+//# sourceMappingURL=metricTemplate.d.ts.map

package/dist/cjs/lib/metricTemplate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metricTemplate.d.ts","sourceRoot":"","sources":["../../../src/lib/metricTemplate.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEpE,wEAAwE;AACxE,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAAI,MAAM,OAAO,CAAC,aAAa,CAAC,EAAE,OAAO,MAAM,KAAG,OAAO,CAAC,oBAAoB,CACc,CAAC;AAE9H;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,GAAI,IAAI,MAAM,EAAE,UAAU,MAAM,EAAE,OAAO,MAAM,KAAG,OAAO,CAAC,oBAAoB,CAM9G,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,GAAI,IAAI,MAAM,EAAE,OAAO,MAAM,KAAG,OAAO,CAAC,oBAAoB,CAGlG,CAAC;AAEJ;;;;;;;GAOG;AACH,eAAO,MAAM,gCAAgC,GAC3C,IAAI,MAAM,EACV,SAAS,MAAM,EACf,6BAA6B,OAAO,EACpC,OAAO,MAAM,KACZ,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAKnC,CAAC;AAEJ;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,GAChC,QAAQ,MAAM,EAAE,EAChB,SAAS,MAAM,EACf,gBAAgB,OAAO,EACvB,SAAS,MAAM,EACf,OAAO,MAAM,KACZ,OAAO,CAAC,oBAAoB,EAAE,CAWhC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,GAAI,IAAI,MAAM,EAAE,UAAU,MAAM,EAAE,OAAO,MAAM,KAAG,OAAO,CAAC,oBAAoB,CAM/G,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B,GACvC,IAAI,MAAM,EACV,MAAM,OAAO,CAAC,aAAa,CAAC,EAC5B,OAAO,MAAM,KACZ,OAAO,CAAC,oBAAoB,CAG5B,CAAC;AAEJ;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,GAChC,IAAI,MAAM,EACV,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,MAAM,KACZ,OAAO,CAAC,oBAAoB,CAK5B,CAAC;AAEJ;;;;;;;;;GASG;AACH,eAAO,MAAM,wCAAwC,GACnD,IAAI,MAAM,EACV,SAAS,MAAM,EACf,SAAS,MAAM,EACf,gBAAgB,OAAO,EACvB,oCAAoC,OAAO,EAC3C,OAAO,MAAM,KACZ,OAAO,CAAC,iBAAiB,EAAE,CAO3B,CAAC;AAEJ;;;;;;;;;GASG;AACH,eAAO,MAAM,4CAA4C,GACvD,IAAI,MAAM,EACV,SAAS,MAAM,EACf,SAAS,MAAM,EACf,gBAAgB,OAAO,EACvB,oCAAoC,OAAO,EAC3C,OAAO,MAAM,KACZ,OAAO,CAAC,iBAAiB,EAAE,CAO3B,CAAC;AAEJ;;;;;;;;;GASG;AACH,eAAO,MAAM,yCAAyC,GACpD,IAAI,MAAM,EACV,SAAS,MAAM,EACf,SAAS,MAAM,EACf,gBAAgB,OAAO,EACvB,oCAAoC,OAAO,EAC3C,OAAO,MAAM,KACZ,OAAO,CAAC,iBAAiB,EAAE,CAO3B,CAAC;AAEJ;;;;;;;;;GASG;AACH,eAAO,MAAM,uCAAuC,GAClD,IAAI,MAAM,EACV,SAAS,MAAM,EACf,SAAS,MAAM,EACf,gBAAgB,OAAO,EACvB,oCAAoC,OAAO,EAC3C,OAAO,MAAM,KACZ,OAAO,CAAC,iBAAiB,EAAE,CAO3B,CAAC"}

package/dist/cjs/lib/metricTemplate.js

@@ -0,0 +1,145 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMetricTemplateRelatedPolicyTemplates = exports.getMetricTemplateRelatedStandardTemplates = exports.getMetricTemplateRelatedRequirementTemplates = exports.getMetricTemplateRelatedControlTemplates = exports.setMetricTemplateTags = exports.setMetricTemplateInformation = exports.publishMetricTemplate = exports.getMetricTemplateList = exports.getMetricTemplateInformationById = exports.discardMetricTemplateChanges = exports.deleteMetricTemplate = exports.createMetricTemplate = void 0;
+const axiosClient_js_1 = require("./axiosClient.js");
+/**
+ * Create metric template and set information
+ * @param {Object} data
+ * @param {String} token Authorization token
+ * @returns {Promise<MetricTemplateRecord>}
+ */
+const createMetricTemplate = (data, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.put("/api/v1/admin/metrictemplates", { data }, { headers: { authorization: token } }));
+exports.createMetricTemplate = createMetricTemplate;
+/**
+ * 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>}
+ */
+const deleteMetricTemplate = (id, comments, token) => {
+    const data = { id };
+    if (comments)
+        data.comments = comments;
+    return (0, axiosClient_js_1.request)(axiosClient_js_1.client.delete("/api/v1/admin/metrictemplates/", { headers: { authorization: token }, data }));
+};
+exports.deleteMetricTemplate = deleteMetricTemplate;
+/**
+ * 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>}
+ */
+const discardMetricTemplateChanges = (id, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.get(`/api/v1/admin/metrictemplates/discard/${id}`, { headers: { authorization: token } }));
+exports.discardMetricTemplateChanges = discardMetricTemplateChanges;
+/**
+ * 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>}
+ */
+const getMetricTemplateInformationById = (id, version, returnNullIfVersionNotFound, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.get(`/api/v1/admin/metrictemplates/${id}/${version}/${returnNullIfVersionNotFound}`, {
+    headers: { authorization: token },
+}));
+exports.getMetricTemplateInformationById = getMetricTemplateInformationById;
+/**
+ * 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[]>}
+ */
+const getMetricTemplateList = (filter, version, includeDeleted, details, token) => {
+    const requestData = { includeDeleted, details, version };
+    if (filter)
+        requestData.filter = filter;
+    return (0, axiosClient_js_1.request)(axiosClient_js_1.client.post("/api/v1/admin/metrictemplates", requestData, { headers: { authorization: token } }));
+};
+exports.getMetricTemplateList = getMetricTemplateList;
+/**
+ * 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>}
+ */
+const publishMetricTemplate = (id, comments, token) => {
+    const data = {};
+    if (comments)
+        data.comments = comments;
+    return (0, axiosClient_js_1.request)(axiosClient_js_1.client.post(`/api/v1/admin/metrictemplates/publish/${id}`, data, { headers: { authorization: token } }));
+};
+exports.publishMetricTemplate = publishMetricTemplate;
+/**
+ * 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>}
+ */
+const setMetricTemplateInformation = (id, data, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.post(`/api/v1/admin/metrictemplates/update`, { data, id }, { headers: { authorization: token } }));
+exports.setMetricTemplateInformation = setMetricTemplateInformation;
+/**
+ * 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>}
+ */
+const setMetricTemplateTags = (id, tags, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.post(`/api/v1/admin/metrictemplates/updatetags`, { tags, id }, {
+    headers: { authorization: token },
+}));
+exports.setMetricTemplateTags = setMetricTemplateTags;
+/**
+ * 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[]>}
+ */
+const getMetricTemplateRelatedControlTemplates = (id, details, version, includeDeleted, returnDefaultIfVersionNotAvailable, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.post(`/api/v1/admin/metrictemplates/controltemplates/${id}`, { details, version, includeDeleted, returnDefaultIfVersionNotAvailable }, { headers: { authorization: token } }));
+exports.getMetricTemplateRelatedControlTemplates = getMetricTemplateRelatedControlTemplates;
+/**
+ * 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[]>}
+ */
+const getMetricTemplateRelatedRequirementTemplates = (id, details, version, includeDeleted, returnDefaultIfVersionNotAvailable, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.post(`/api/v1/admin/metrictemplates/requirementtemplates/${id}`, { details, version, includeDeleted, returnDefaultIfVersionNotAvailable }, { headers: { authorization: token } }));
+exports.getMetricTemplateRelatedRequirementTemplates = getMetricTemplateRelatedRequirementTemplates;
+/**
+ * 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[]>}
+ */
+const getMetricTemplateRelatedStandardTemplates = (id, details, version, includeDeleted, returnDefaultIfVersionNotAvailable, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.post(`/api/v1/admin/metrictemplates/standardtemplates/${id}`, { details, version, includeDeleted, returnDefaultIfVersionNotAvailable }, { headers: { authorization: token } }));
+exports.getMetricTemplateRelatedStandardTemplates = getMetricTemplateRelatedStandardTemplates;
+/**
+ * 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[]>}
+ */
+const getMetricTemplateRelatedPolicyTemplates = (id, details, version, includeDeleted, returnDefaultIfVersionNotAvailable, token) => (0, axiosClient_js_1.request)(axiosClient_js_1.client.post(`/api/v1/admin/metrictemplates/policytemplates/${id}`, { details, version, includeDeleted, returnDefaultIfVersionNotAvailable }, { headers: { authorization: token } }));
+exports.getMetricTemplateRelatedPolicyTemplates = getMetricTemplateRelatedPolicyTemplates;
+//# sourceMappingURL=metricTemplate.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"metricTemplate.js","sourceRoot":"","sources":["../../../src/lib/metricTemplate.ts"],"names":[],"mappings":";;;AAAA,qDAAmD;AAYnD;;;;;GAKG;AACI,MAAM,oBAAoB,GAAG,CAAC,IAA4B,EAAE,KAAa,EAAiC,EAAE,CACjH,IAAA,wBAAO,EAAuB,uBAAM,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;AADjH,QAAA,oBAAoB,wBAC6F;AAE9H;;;;;;GAMG;AACI,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,IAAA,wBAAO,EACZ,uBAAM,CAAC,MAAM,CAAC,gCAAgC,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,CAC7F,CAAC;AACJ,CAAC,CAAC;AANW,QAAA,oBAAoB,wBAM/B;AAEF;;;;;GAKG;AACI,MAAM,4BAA4B,GAAG,CAAC,EAAU,EAAE,KAAa,EAAiC,EAAE,CACvG,IAAA,wBAAO,EACL,uBAAM,CAAC,GAAG,CAAC,yCAAyC,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CACjG,CAAC;AAHS,QAAA,4BAA4B,gCAGrC;AAEJ;;;;;;;GAOG;AACI,MAAM,gCAAgC,GAAG,CAC9C,EAAU,EACV,OAAe,EACf,2BAAoC,EACpC,KAAa,EACyB,EAAE,CACxC,IAAA,wBAAO,EACL,uBAAM,CAAC,GAAG,CAAC,iCAAiC,EAAE,IAAI,OAAO,IAAI,2BAA2B,EAAE,EAAE;IAC1F,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CAAC,CACH,CAAC;AAVS,QAAA,gCAAgC,oCAUzC;AAEJ;;;;;;;;GAQG;AACI,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,IAAA,wBAAO,EACZ,uBAAM,CAAC,IAAI,CAAC,+BAA+B,EAAE,WAAW,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CACjG,CAAC;AACJ,CAAC,CAAC;AAjBW,QAAA,qBAAqB,yBAiBhC;AAEF;;;;;;GAMG;AACI,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,IAAA,wBAAO,EACZ,uBAAM,CAAC,IAAI,CAAC,yCAAyC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CACxG,CAAC;AACJ,CAAC,CAAC;AANW,QAAA,qBAAqB,yBAMhC;AAEF;;;;;;GAMG;AACI,MAAM,4BAA4B,GAAG,CAC1C,EAAU,EACV,IAA4B,EAC5B,KAAa,EACkB,EAAE,CACjC,IAAA,wBAAO,EACL,uBAAM,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CACzG,CAAC;AAPS,QAAA,4BAA4B,gCAOrC;AAEJ;;;;;;GAMG;AACI,MAAM,qBAAqB,GAAG,CACnC,EAAU,EACV,IAA6B,EAC7B,KAAa,EACkB,EAAE,CACjC,IAAA,wBAAO,EACL,uBAAM,CAAC,IAAI,CAAC,0CAA0C,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE;IACpE,OAAO,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;CAClC,CAAC,CACH,CAAC;AATS,QAAA,qBAAqB,yBAS9B;AAEJ;;;;;;;;;GASG;AACI,MAAM,wCAAwC,GAAG,CACtD,EAAU,EACV,OAAe,EACf,OAAe,EACf,cAAuB,EACvB,kCAA2C,EAC3C,KAAa,EACiB,EAAE,CAChC,IAAA,wBAAO,EACL,uBAAM,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;AAdS,QAAA,wCAAwC,4CAcjD;AAEJ;;;;;;;;;GASG;AACI,MAAM,4CAA4C,GAAG,CAC1D,EAAU,EACV,OAAe,EACf,OAAe,EACf,cAAuB,EACvB,kCAA2C,EAC3C,KAAa,EACiB,EAAE,CAChC,IAAA,wBAAO,EACL,uBAAM,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;AAdS,QAAA,4CAA4C,gDAcrD;AAEJ;;;;;;;;;GASG;AACI,MAAM,yCAAyC,GAAG,CACvD,EAAU,EACV,OAAe,EACf,OAAe,EACf,cAAuB,EACvB,kCAA2C,EAC3C,KAAa,EACiB,EAAE,CAChC,IAAA,wBAAO,EACL,uBAAM,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;AAdS,QAAA,yCAAyC,6CAclD;AAEJ;;;;;;;;;GASG;AACI,MAAM,uCAAuC,GAAG,CACrD,EAAU,EACV,OAAe,EACf,OAAe,EACf,cAAuB,EACvB,kCAA2C,EAC3C,KAAa,EACiB,EAAE,CAChC,IAAA,wBAAO,EACL,uBAAM,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;AAdS,QAAA,uCAAuC,2CAchD"}

package/dist/cjs/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