@sassoftware/vi-api 1.42.0 → 1.44.0

package/elements/identity-select.d.ts

@@ -0,0 +1,274 @@
+import { SASInputBindings } from ".";
+import { IdentitySummary } from "../current-user";
+/**
+ * Properties for {@link SVICustomElement.IdentitySelect}.
+ *
+ * @category Properties
+ *
+ * @example HTML Example #1 - Provide a custom set of User/Group identities to display in dialog
+ * ```html
+ * <svi-identity-select
+ *   [model]="selectedIdentities"
+ *   [identities]="myIdentitiesList"
+ *   [selectionMode]="SelectionMode.UsersAndGroups"
+ *   [selfSelectBtn]="true"
+ *   [filter]="{ byGroups: ['alpha', 'bravo'] }"
+ *   (modelChanged)="onSelectionChange($event)"
+ * ></svi-identity-select>
+ * ```
+ *
+ *  @example HTML Example #2 - Retrieve a list of users from the identities service in dialog
+ * ```html
+ * <svi-identity-select
+ *   [model]="selectedIdentities"
+ *   [ariaLabel]="'Select Users'"
+ *   [selectionMode]="SelectionMode.Users"
+ *   [selfSelectBtn]="true"
+ *   (modelChanged)="onSelectionChange($event)"
+ * ></svi-identity-select>
+ * ```
+ *
+ * @example Create element via document.createElement:
+ * ```ts
+ * const identitySelect = document.createElement(SVICustomElement.IdentitySelect);
+ * identitySelect.identities = this.myIdentitiesList;
+ * identitySelect.ariaLabel = "My label";
+ * ```
+ */
+export interface IdentitySelectProperties extends SASInputBindings {
+    /** ARIA label for identifying the list. */
+    ariaLabel?: string;
+    /** The available users and groups to select from. If not provided, the identities are retrieved from the identities microservice. */
+    identities?: IIdentityOption[];
+    /** Does the input allow the selection of only a user, users, a group, groups, or both?  (default: {@link SelectionMode.UsersAndGroups}) */
+    selectionMode?: SelectionMode;
+    /** Determines whether the select current user button is displayed. (default: false) */
+    selfSelectBtn?: boolean;
+    /** Determines if the current user button is displayed above or to the left/right of the identity-select control. (default: false) */
+    inlineSelectCurrentUserBtn?: boolean;
+    /** The filtering options used when the available identities are retrieved from the identities microservice. (default: false) */
+    filter?: IIdentitySelectFilterOptions;
+    /**
+     * Only members of the given group will be valid and selectable. If inclusive if true,
+     * the group itself is treated as a valid selection.
+     *
+     * Accepts the group id as a string, or as part of configuration object.
+     */
+    limitSelectionToMembersOf?: string | ILimitSelectionToConfig;
+    /** Optional title that can be used to override the default dialog title. */
+    title?: string;
+}
+/**
+ * Properties for {@link SVICustomElement.IdentitySelectAction}.
+ *
+ * @category Properties
+ *
+ * @example HTML Example #1 - Select Users and Groups
+ * ```html
+ * <svi-identity-select-action
+ *   [model]="selectedIdentities"
+ *   [title]="'Multiple Users and Groups from Button'"
+ *   [hideLabel]="true"
+ *   (selectionDialogClose)="onDialogClose($event)"
+ *   (modelChanged)="onSelectionChange($event)"
+ * ></svi-identity-select-action>
+ * ```
+ *
+ * @example HTML Example #1 - Select Users Only
+ * ```html
+ * <svi-identity-select-action
+ *   [model]="selectedIdentities"
+ *   [title]="'Multiple Users from Button'"
+ *   [hideLabel]="true"
+ *   [selectionMode]="selectionMode.Users"
+ *   (selectionDialogClose)="onDialogClose($event)"
+ *   (modelChanged)="onSelectionChange($event)"
+ * ></svi-identity-select-action>
+ * ```
+ *
+ * @example Create element via document.createElement:
+ * ```ts
+ * const identityAvatar = document.createElement(SVICustomElement.IdentitySelectAction);
+ * identitySelect.title = this.title;
+ * identitySelect.actionMode = this.actionMode;
+ * ```
+ */
+export interface IdentitySelectActionProperties {
+    /** Determines if the action is rendered as a Button or MenuItem (default: {@link ActionMode.Button}). */
+    actionMode?: ActionMode;
+    /** The tabIndex for the button (default: {@link TabIndex.Tabbable}). */
+    tabIndex?: string;
+    /** Optional title that can be used to override the default dialog title. */
+    title?: string;
+    /** Optional label that can be used to override the default button label.  */
+    label?: string;
+    /** Defines if the label will be hidden. (default: false). */
+    hideLabel?: boolean;
+    /** Label for the identity select dialog "ok" button. (default: "ok") */
+    okButtonLabel?: string;
+    /** Optional icon class that can be used to override the default button icon. */
+    iconClass?: string;
+    /** Disables the component's controls. (default: false) */
+    disabled?: boolean;
+    /** The available users and groups to select from. If not provided, the identities are retrieved from the identities microservice. */
+    identities?: IIdentityOption[];
+    /** Does the input allow the selection of only a user, users, a group, groups, or both? (default: {@link SelectionMode.UsersAndGroups}) */
+    selectionMode?: SelectionMode;
+    /** Pre-select Identities. */
+    selectedIdentities?: IIdentityOption[];
+    /** The filtering options used when the available identities are retrieved from the identities microservice. */
+    filter?: IIdentitySelectFilterOptions;
+    /**
+     * Only members of the given group will be valid and selectable. If inclusive if true,
+     * the group itself is treated as a valid selection.
+     *
+     * Accepts the group id as a string, or as part of configuration object.
+     */
+    limitSelectionToMembersOf?: string | ILimitSelectionToConfig;
+    /** Emits the selected identities when the dialog's ok button is clicked. */
+    selectionDialogClose?: (event: CustomEvent) => void;
+}
+/**
+ * Properties for {@link SVICustomElement.Avatar}.
+ *
+ * @category Properties
+ *
+ * @example HTML Example
+ * ```html
+ * <svi-avatar
+ *   [identity]="identity"
+ *   [size]="SizeType.XLarge"
+ *   [isIcon]="true"
+ *   [isButton]="true"
+ * ></svi-avatar>
+ * ```
+ *
+ * @example Create element via document.createElement:
+ * ```ts
+ * const identityAvatar = document.createElement(SVICustomElement.IdentityAvatar);
+ * identitySelect.identity = this.identity;
+ * identitySelect.size = SizeType.XLarge;
+ * identitySelect.isButton = true;
+ * ```
+ */
+export interface AvatarProperties {
+    /** The identity of the user, including name, userID, user type, and any tooltips. (required) */
+    identity: AvatarData;
+    /** Specifies the size styling the avatar should use. */
+    size?: SizeType;
+    /** Specifies if the avatar is a clickable button. */
+    isButton?: boolean;
+    /** The user's photo, if provided. */
+    imgSrcUrl?: string;
+    /** Specifies whether the avatar displays an icon (user or group) or a non-icon (initial or image). */
+    isIcon?: boolean;
+}
+/** @category Identities Types */
+export declare enum SizeType {
+    Small = "small",
+    Medium = "medium",
+    XLarge = "x-large"
+}
+/** @category Identities Types */
+export declare enum TabIndex {
+    Tabbable = "0",
+    NotTabbable = "-1"
+}
+/** @category Identities Types */
+export declare enum IdentityType {
+    User = "user",
+    Group = "group"
+}
+/** @category Identities Types */
+export declare enum IdentityState {
+    Active = "active",
+    Inactive = "inactive",
+    Locked = "locked"
+}
+/** @category Identities Types */
+export interface GroupSummary extends IdentitySummary {
+    /** The value of "group" */
+    readonly type: IdentityType.Group;
+}
+/** @category Identities Types */
+export interface UserSummary extends IdentitySummary {
+    /** The value of "user" */
+    readonly type: IdentityType.User;
+}
+/** @category Identities Types */
+export interface AvatarData {
+    /** The name of the avatar file */
+    name?: string;
+    /** The content-type of the avatar file. */
+    type?: string;
+    /** Describes whether or not the avatar file for this identity is a default image. */
+    default?: boolean;
+    /** The uri location of the avatar file only if stored externally. */
+    uri?: string;
+    /** Timestamp of avatar data creation */
+    creationTimeStamp?: Date;
+    /** Timestamp of last avatar data modification */
+    modifiedTimeStamp?: Date;
+}
+/** @category Identities Types */
+export declare enum ActionMode {
+    Button = "button",
+    MenuItem = "menuItem"
+}
+/** @category Identities Types */
+export declare enum SelectionMode {
+    User = "user",
+    Group = "group",
+    Users = "users",
+    Groups = "groups",
+    UserOrGroup = "userOrGroup",
+    UsersAndGroups = "usersAndGroups"
+}
+/** @category Identities Types */
+export type IdentitySelection = Array<{
+    id: string;
+    type: IdentityType;
+}>;
+/** @category Identities Types */
+export interface IIdentitySelectDialogData {
+    identities?: IIdentityOption[];
+    selection?: IdentitySelection;
+    selectionMode: SelectionMode;
+    filter?: IIdentitySelectFilterOptions;
+    limitSelectionToMembersOf?: string | ILimitSelectionToConfig;
+    title?: string;
+    okButtonLabel?: string;
+    showSelectCurrentUserButton?: boolean;
+}
+/** @category Identities Types */
+export interface IIdentityOption {
+    label?: string;
+    icon?: string;
+}
+/** @category Identities Types */
+export declare const enum IdentityTypeIcon {
+    User = "userIcon",
+    Group = "userGroupIcon",
+    UserAndGroup = "userGroupLimitIcon"
+}
+/** @category Identities Types */
+export interface IIdentitySelectFilterOptions {
+    byGroups: string[];
+    includeNestedMembers?: boolean;
+    includeFilteredGroups?: boolean;
+    term?: string;
+    start?: number;
+    limit?: number;
+    cache?: number;
+}
+/** @category Identities Types */
+export interface IFilterGroup {
+    id: string;
+    name?: string;
+    members: IdentitySummary[];
+}
+/** @category Identities Types */
+export interface ILimitSelectionToConfig {
+    id: string;
+    inclusive?: boolean;
+}

package/elements/identity-select.js

@@ -0,0 +1,24 @@
+import { expectType } from "../../shared/util/helper-functions";
+/** @category Identities Types */
+export var SizeType;
+(function (SizeType) {
+    SizeType["Small"] = "small";
+    SizeType["Medium"] = "medium";
+    SizeType["XLarge"] = "x-large";
+})(SizeType || (SizeType = {}));
+/** @category Identities Types */
+export var IdentityType;
+(function (IdentityType) {
+    IdentityType["User"] = "user";
+    IdentityType["Group"] = "group";
+})(IdentityType || (IdentityType = {}));
+/** @category Identities Types */
+export var IdentityState;
+(function (IdentityState) {
+    IdentityState["Active"] = "active";
+    IdentityState["Inactive"] = "inactive";
+    IdentityState["Locked"] = "locked";
+})(IdentityState || (IdentityState = {}));
+expectType(true);
+expectType(true);
+expectType(true);

package/elements/index.d.ts

@@ -2,13 +2,11 @@
  * SAS Visual Investigator exposes a number of controls within the DOM as Custom Elements.
  *
  * See {@link SVICustomElement} for the list of available SVI Custom Elements.
- *
- * @module
  */
 /**
  * This enumeration list contains the tag names of all SVI custom elements.
  *
- * @category CustomElement
+ * @category Properties
  */
 export declare enum SVICustomElement {
     /**
@@ -25,6 +23,27 @@ export declare enum SVICustomElement {
      *
      * See {@link MaskToggleButtonProperties} for supported input bindings.
      */
-    MaskToggleButton = "svi-mask-toggle-button"
+    MaskToggleButton = "svi-mask-toggle-button",
+    /**
+     * A token input that spawns a dialog for selecting a set of users, a set of groups, or a set of users and groups.
+     *
+     * See {@link IdentitySelectProperties} for supported input bindings.
+     */
+    IdentitySelect = "svi-identity-select",
+    /**
+     * A button for selecting a set of users, a set of groups, or a set of users and groups.
+     *
+     * See {@link IdentitySelectActionProperties} for supported input bindings.
+     */
+    IdentitySelectAction = "svi-identity-select-action",
+    /**
+     * An input to select a set of users, a set of groups, or a set of users and groups.
+     *
+     * See {@link AvatarProperties} for supported input bindings.
+     */
+    Avatar = "svi-avatar"
 }
-export * from "./properties";
+export * from "./bindings";
+export * from "./identity-select";
+export * from "./labelled-control";
+export * from "./mask-toggle-button";

package/elements/index.js

@@ -2,13 +2,11 @@
  * SAS Visual Investigator exposes a number of controls within the DOM as Custom Elements.
  *
  * See {@link SVICustomElement} for the list of available SVI Custom Elements.
- *
- * @module
  */
 /**
  * This enumeration list contains the tag names of all SVI custom elements.
  *
- * @category CustomElement
+ * @category Properties
  */
 export var SVICustomElement;
 (function (SVICustomElement) {
@@ -27,5 +25,26 @@ export var SVICustomElement;
      * See {@link MaskToggleButtonProperties} for supported input bindings.
      */
     SVICustomElement["MaskToggleButton"] = "svi-mask-toggle-button";
+    /**
+     * A token input that spawns a dialog for selecting a set of users, a set of groups, or a set of users and groups.
+     *
+     * See {@link IdentitySelectProperties} for supported input bindings.
+     */
+    SVICustomElement["IdentitySelect"] = "svi-identity-select";
+    /**
+     * A button for selecting a set of users, a set of groups, or a set of users and groups.
+     *
+     * See {@link IdentitySelectActionProperties} for supported input bindings.
+     */
+    SVICustomElement["IdentitySelectAction"] = "svi-identity-select-action";
+    /**
+     * An input to select a set of users, a set of groups, or a set of users and groups.
+     *
+     * See {@link AvatarProperties} for supported input bindings.
+     */
+    SVICustomElement["Avatar"] = "svi-avatar";
 })(SVICustomElement || (SVICustomElement = {}));
-export * from "./properties";
+export * from "./bindings";
+export * from "./identity-select";
+export * from "./labelled-control";
+export * from "./mask-toggle-button";

package/elements/labelled-control.d.ts

@@ -0,0 +1,47 @@
+import { PageControlBindings } from ".";
+/**
+ * Properties for {@link SVICustomElement.LabelledControl}.
+ *
+ * @category Properties
+ *
+ * @example HTML Example:
+ * ```html
+ * <svi-labelled-control
+ *   [childNode]="childNode"
+ *   [pageModel]="pageModel"
+ * >
+ *   <!-- my control -->
+ * </svi-labelled-control>
+ * ```
+ *
+ * @example Create the element via document.createElement:
+ * ```ts
+ * const labelledControl = document.createElement(SVICustomElement.LabelledControl);
+ * labelledControl.pageModel = this.pageModel;
+ * labelledControl.childNode = this.childNode;
+ * labelledControl.appendChild(myControlElement)
+ * ```
+ */
+export interface LabelledControlProperties extends PageControlBindings {
+    /** Set the label as required. */
+    isRequired?: boolean;
+    /** Set the label as disabled. */
+    isDisabled?: boolean;
+    /** Override the text displayed in the label. */
+    overrideLabel?: string;
+    /** Add css classes to the label element. */
+    labelClass?: string;
+    /**
+     * Specify which dataSource the label's mask-toggle-button will toggle.
+     *
+     * If no {@link MaskToggleButtonProperties.dataSource | dataSource} is specified,
+     * the mask-toggle-button will toggle the dataSource(s) defined in the childNode's typeAttributes.
+     */
+    dataSource?: string;
+    /** Disable the label's mask toggle button. */
+    disableMaskToggle?: boolean;
+    /** Hide the label's mask toggle button. */
+    hideMaskToggle?: boolean;
+    /** Set the label's `for` attribute. */
+    for?: string;
+}

package/elements/labelled-control.js

@@ -0,0 +1 @@
+export {};

package/elements/mask-toggle-button.d.ts

@@ -0,0 +1,37 @@
+import { PageControlBindings } from ".";
+/**
+ * Properties for {@link SVICustomElement.MaskToggleButton}.
+ *
+ * @category Properties
+ *
+ * @example HTML Example
+ * ```html
+ * <svi-mask-toggle-button
+ *   [childNode]="childNode"
+ *   [pageModel]="pageModel"
+ * >
+ * </svi-mask-toggle-button>
+ * ```
+ *
+ * @example Create element via document.createElement:
+ * ```ts
+ * const maskToggleBtn = document.createElement(SVICustomElement.MaskToggleButton);
+ * maskToggleBtn.pageModel = this.pageModel;
+ * maskToggleBtn.childNode = this.childNode;
+ * ```
+ */
+export interface MaskToggleButtonProperties extends PageControlBindings {
+    /**
+     * Specify which dataSource will be toggled.
+     *
+     * If no {@link MaskToggleButtonProperties.dataSource | dataSource} is specified,
+     * the mask-toggle-button will toggle the dataSource(s) defined in the childNode's typeAttributes.
+     */
+    dataSource?: string;
+    /** Disable the mask toggle button. */
+    disabled?: boolean;
+    /** Hide the mask toggle button. */
+    hidden?: boolean;
+    /** Override the control name displayed in the authorization dialog. */
+    controlName?: string;
+}

package/elements/mask-toggle-button.js

@@ -0,0 +1 @@
+export {};

package/event/event-api.d.ts

@@ -17,8 +17,9 @@ export declare enum PageEvents {
     UpdateSubDocumentTypeEvent = "spb::updateSubDocumentType",
     TabSelectedEvent = "spb::tabSelected",
     VisitAllTabs = "spb::mark-all-tabs-visited",
-    MaskToggleEvent = "spb::mask-toggle",
-    MaskAllEvent = "spb::mask-all",
+    MaskEvent = "spb::mask",
+    UnmaskEvent = "spb::unmask",
+    MaskResetEvent = "spb::mask-reset",
     ClearDateFieldEvent = "spb::clear-date-field"
 }
 export declare enum DocumentGeneratorEvents {

package/event/event-api.js

@@ -18,8 +18,9 @@ export var PageEvents;
     PageEvents["UpdateSubDocumentTypeEvent"] = "spb::updateSubDocumentType";
     PageEvents["TabSelectedEvent"] = "spb::tabSelected";
     PageEvents["VisitAllTabs"] = "spb::mark-all-tabs-visited";
-    PageEvents["MaskToggleEvent"] = "spb::mask-toggle";
-    PageEvents["MaskAllEvent"] = "spb::mask-all";
+    PageEvents["MaskEvent"] = "spb::mask";
+    PageEvents["UnmaskEvent"] = "spb::unmask";
+    PageEvents["MaskResetEvent"] = "spb::mask-reset";
     PageEvents["ClearDateFieldEvent"] = "spb::clear-date-field";
 })(PageEvents || (PageEvents = {}));
 export var DocumentGeneratorEvents;

package/object/object-api.d.ts

@@ -63,19 +63,20 @@ export interface ObjectApi {
      * @param objectType {string} Object type.
      * @param objectId {string} Object ID.
      * @param [includeDisplayLabel = true] {boolean} Checks whether or not to return the object with a display label.
+     * @param [includeChildObjects = false] {boolean} Checks whether or not to return the child objects associated with this object.
      * @return The specified object.
      */
-    getObject(objectType: string, objectId: string, includeDisplayLabel?: boolean): Promise<VIObject>;
+    getObject(objectType: string, objectId: string, includeDisplayLabel?: boolean, includeChildObjects?: boolean): Promise<VIObject>;
     /**
      * @method
      * @description Gets the child objects of an object.
      * @param objectType {string} Object type.
      * @param objectId {string} Gets the child objects relating to the object ID.
      * @param childObjectType {string} Child object type.
-     * @param [maxResponses = 25] {number} Maximum number of child objects to be returned.
+     * @param [limit = 25] {number} Maximum number of child objects to be returned.
      * @return A Promise that resolves to an array of objects, that are child objects of the specified object.
      */
-    getChildObjects(objectType: string, objectId: string, childObjectType: string, maxResponses?: number): Promise<VIObject[]>;
+    getChildObjects(objectType: string, objectId: string, childObjectType: string, limit?: number): Promise<VIObject[]>;
     /**
      * @method
      * @description Updates an existing object with the provided data.
@@ -97,10 +98,11 @@ export interface ObjectApi {
      * @param objectTypeVersion {number} Object type version.
      * @param originalFieldValues {FieldValues} Field values before the object was edited
      * @param newFieldValues {FieldValues} Field values after the object was edited
+     * @param objectVersion {number} Object Version
      * @param [options] {UpdateObjectOptions} Optional extra parameters.
      * @return A Promise that resolves to the updated object when the object has successfully been updated.
      */
-    patchObject(objectType: string, objectId: string, objectTypeId: number, objectTypeVersion: number, originalFieldValues: FieldValues, newFieldValues: FieldValues, options?: UpdateObjectOptions): Promise<VIObject>;
+    patchObject(objectType: string, objectId: string, objectTypeId: number, objectTypeVersion: number, originalFieldValues: FieldValues, newFieldValues: FieldValues, objectVersion: number, options?: UpdateObjectOptions): Promise<VIObject>;
     /**
      * @method
      * @description Deletes an object.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sassoftware/vi-api",
-  "version": "1.42.0",
+  "version": "1.44.0",
   "description": "Types used in the SAS Visual Investigator API",
   "keywords": [
     "SAS",

package/page-model/page-model-api.d.ts

@@ -149,7 +149,7 @@ export interface IPageEventData {
 /**
  * Page model events which can have pre-event or post-event hooks.
  */
-export declare const enum HookablePageEvents {
+export declare enum HookablePageEvents {
     /**
      * A pagemodel is being saved as an object.
      */

package/page-model/page-model-api.js

@@ -5,6 +5,16 @@ export var PageMode;
     PageMode["View"] = "view";
     PageMode["Design"] = "design";
 })(PageMode || (PageMode = {}));
+/**
+ * Page model events which can have pre-event or post-event hooks.
+ */
+export var HookablePageEvents;
+(function (HookablePageEvents) {
+    /**
+     * A pagemodel is being saved as an object.
+     */
+    HookablePageEvents["SaveObject"] = "svi:hookable:pagemodel:saveObject";
+})(HookablePageEvents || (HookablePageEvents = {}));
 /**
  * @typedef {object} PageModelApi~CreateFromObjectOptions
  * @property [clone] {boolean} Whether or not to clone the page model data or use the referenced values.

package/score-reps/index.d.ts

@@ -1,6 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
-// Generated using typescript-generator version 2.15.527 on 2024-04-29 09:50:32.
+// Generated using typescript-generator version 2.15.527 on 2024-10-22 14:13:02.
 
 export interface BaseRep extends TrackedResource {
     links?: Link[];
@@ -55,6 +55,12 @@ export interface EntityElementsRep {
     version?: number;
 }
 
+export interface ScorecardConstants {
+}
+
+export interface Length {
+}
+
 export interface ScorecardDefinitionRep extends BaseRep {
     currentTableName?: string;
     domainId?: string;
@@ -86,7 +92,7 @@ export interface ScorecardSummaryRep extends BaseRep {
     effectiveTimeStamp?: string;
 }
 
-export interface Link extends Serializable {
+export interface Link extends Serializable, Comparable<Link> {
     method?: string;
     rel?: string;
     href?: string;
@@ -117,6 +123,9 @@ export interface TimeTrackedResource extends LastModifiedProviderFromModifiedTim
 export interface ETagAndLastModifiedProvider extends ETaggable, LastModifiedProvider {
 }
 
+export interface Comparable<T> {
+}
+
 export interface Preconditionable {
 }
 

package/score-reps/package.json

@@ -1,5 +1,5 @@
 {
   "name": "@types/score-reps",
-  "version": "6.0.3",
+  "version": "7.4.4",
   "types": "index.d.ts"
 }