@sassoftware/vi-api 0.0.29

package/metadata/metadata-api.d.ts

@@ -0,0 +1,237 @@
+import { CoreStoredObjectField, Entity, Relationship, RelationshipDTO, StoredObjectDTO } from "../svi-datahub";
+export interface NodeShapeMultipliers {
+    square: number;
+    circle: number;
+    ellipse: number;
+    triangle: number;
+    hexagon: number;
+    pentagon: number;
+    diamond: number;
+    custom: number;
+}
+export interface SandServicesField {
+    name: string;
+    value: string;
+}
+export interface EntityMetadata {
+    [entityName: string]: SandDataObject;
+}
+export interface SandDataObject extends DataObject {
+    parentName?: string;
+    label?: string;
+    relationshipsFrom?: any;
+    relationshipsTo?: any;
+    attachmentsIndexedForSearch?: boolean;
+    resolvedEntity?: boolean;
+    indexedForSearch?: boolean;
+}
+export interface DataObject extends PersistableObject {
+    name: string;
+    dataStoreName: string;
+    tableName: string;
+    deleteTableName?: string;
+    readOnly: boolean;
+    archived: boolean;
+    historyEnabled?: boolean;
+    systemReserved: boolean;
+    type?: string;
+    fields: DataObjectField[];
+    fileCategories?: FileCategory[];
+}
+export interface FileCategory {
+    name: string;
+    displayName: string;
+    required: boolean;
+    allowMultiple: boolean;
+    documentLockRequired: boolean;
+    filesExist?: boolean;
+}
+export interface DataObjectField extends PersistableObject, LocalizableObject {
+    name: string;
+    label: string;
+    columnName: string;
+    dataType: string;
+    length: number;
+    precision: number;
+    displayIndex: number;
+    unique: boolean;
+    required: boolean;
+    readOnly: boolean;
+    readOnlyConditionally: {
+        conditionId: string;
+        objectState: "ENTERED" | "SAVED";
+    };
+    requiredConditionally: {
+        conditionId: string;
+        objectState: "ENTERED" | "SAVED";
+    };
+    primaryKeyField: boolean;
+    archived: boolean;
+    systemReserved: boolean;
+    multiValued: boolean;
+    autoGenerated: boolean;
+    autoGenStartValue: number;
+    ownerName: string;
+    jsonSchema: string;
+    constrainingListName?: string;
+    cascadingReferenceDataName?: string;
+    cascadingReferenceDataFilterByCode?: string;
+    cascadingReferenceDataFilterByField?: string;
+    [index: string]: any;
+}
+export interface LocalizableObject {
+    label?: string;
+    localizedLabels: LocalizedLabel[];
+    description?: string;
+    localizedDescriptions: LocalizedDescription[];
+}
+export interface LocalizedLabel extends PersistableObject {
+    localeCd: string;
+    label: string;
+}
+export interface LocalizedDescription extends PersistableObject {
+    localeCd: string;
+    description: string;
+}
+export interface PersistableObject {
+    id?: number;
+    createdBy?: string;
+    createdAt?: Date;
+    lastUpdatedBy?: string;
+    lastUpdatedAt?: Date;
+    version?: number;
+}
+export interface ValidRelationshipTypes {
+    [relationshipName: string]: RelationshipTypes;
+}
+export interface RelationshipTypes {
+    isIndexedForSearch: boolean;
+    linkTypes: Relationship[];
+    name: string;
+    searchBeforeCreate: boolean;
+}
+export interface EntityAccessRules {
+    create: Promise<boolean>;
+    read: Promise<boolean>;
+    update: Promise<boolean>;
+}
+export interface ReferenceDataItem {
+    group?: string;
+    displayText: string;
+    value: string | null;
+}
+export declare type Picklist = ReferenceDataItem[];
+export interface RelationshipWithLabel extends RelationshipDTO {
+    relationshipLabel?: string;
+}
+export interface ReferenceDataOptions {
+    constrainingListName?: string;
+    parentCode?: string;
+}
+/**
+ * This API provides the functionality related to retrieval of metadata.
+ * Accessed from the window at window.sas.vi.metadata.
+ */
+export interface MetadataApi {
+    /**
+     * @method
+     * @description Gets create, read and update access rights for an entity.
+     * @param objectType {string} Entity name.
+     * @returns Object with a promise of type boolean for each rule.
+     */
+    getEntityAccessRules(objectType: string): EntityAccessRules;
+    /**
+     * @method
+     * @description Checks access rights and gets metadata for an entity. Returns undefined if the entity does not exist.
+     * @param objectType {string} Entity name.
+     * @returns A promise containing the entity metadata.
+     */
+    getEntity(objectType: string): Promise<StoredObjectDTO | undefined>;
+    /**
+     * @method
+     * @description Gets metadata for an entity field.
+     * @param objectType {string} Entity name.
+     * @param fieldName {string} Field name.
+     * @returns A promise containing the field metadata.
+     */
+    getField(objectType: string, fieldName: string): Promise<CoreStoredObjectField>;
+    /**
+     * @method
+     * @description Gets managed entity types.
+     * @returns A promise containing an array of managed entity types
+     */
+    getManagedEntityTypes(): Promise<StoredObjectDTO[]>;
+    /**
+     * @method
+     * @description Gets root type entities that are not child types.
+     * @returns A promise containing an array of root types
+     */
+    getRootTypes(): Promise<StoredObjectDTO[]>;
+    /**
+     * @method
+     * @description Gets child entity types for a given entity.
+     * @param objectType {string} Checks for children for the named entity.
+     * @returns A promise containing an array of child entity types or an empty list if none are found.
+     */
+    getChildEntityTypes(objectType: string): Promise<StoredObjectDTO[]>;
+    /**
+     * @method
+     * @description Gets valid relationship types for a specified entity.
+     * If relationshipObjectType and RelationshipName are provided, the link types are filtered accordingly.
+     * Otherwise, all valid relationships related to the objectType are returned.
+     * @param objectType {string} Finds relationships for the entity.
+     * @param [relationshipObjectType] {string} Used for filtering the name of an expected related entity.
+     * @param [relationshipName] {string} Used for filtering the name of an expected relationship.
+     * @returns A Promise resolving to an object containing relationship type metadata.
+     * The object is empty if no relationship types exist.
+     */
+    getAllValidRelationshipTypes(objectType: string, relationshipObjectType?: string, relationshipName?: string): Promise<ValidRelationshipTypes>;
+    /**
+     * @method
+     * @description Gets metadata for all resolved entities
+     * @returns A promise containing an array of the resolved entities metadata.
+     */
+    getResolvedEntities(): Promise<Entity[]>;
+    /**
+     * @method
+     * @description Gets metadata for a resolved entity.
+     * @param objectType {string} Resolved Entity Name.
+     * @returns A promise containing resolved entity metadata or undefined if none exists.
+     */
+    getResolvedEntityMetadata(objectType: string): Promise<Entity | undefined>;
+    /**
+     * @method
+     * @description Gets the icon path for an entity.
+     * @param objectType {string} Entity name.
+     * @param [iconType] {string} Icon type. If iconType is not provided it is set to REGULAR by default.
+     * @returns A string containing the icon path. Returns undefined if objectType is empty.
+     */
+    getIconForEntity(objectType: string, iconType?: string): string | undefined;
+    /**
+     * @method
+     * @description Gets metadata for both entities and resolved entities
+     * @returns A promise resolving to Search entity metadata.
+     */
+    getSearchMetadata(): Promise<EntityMetadata>;
+    /**
+     * @method
+     * @description Gets reference data with the given name.
+     * @param refDataName {string} Reference data list name.
+     * @param [options] {ReferenceDataOptions} Object containing name and filter constraints.
+     * If constrainingListName is defined, then the refDataName parameter is ignored.
+     * parentCode is used to filter list items to those that are children of this list name.
+     * @returns Promise containing the reference data or undefined if none exists.
+     */
+    getReferenceData(name: string, options?: {
+        constrainingListName?: string;
+        parentCode?: string;
+    }): Promise<Picklist | undefined>;
+    /**
+     * @method
+     * @description Gets relationships with a specified end type.
+     * @param endType {string} End type entity name.
+     * @param [includeHeterogeneous = false] {boolean} Boolean value to determine whether heterogeneous relationships are included.
+     * @returns A Promise resolving to a list of relationships, or an empty list if none are found.
+     */
+    getRelationshipsFilteredByEndType(endType: string, includeHeterogeneous?: boolean): Promise<RelationshipWithLabel[]>;
+}

package/metadata/metadata-api.js

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

package/metadata/package.json

@@ -0,0 +1,9 @@
+{
+    "name": "@sassoftware/vi-api/metadata",
+    "files": [
+        "**/*.d.ts",
+        "**/*.js"
+    ],
+    "main": "public-api.js",
+    "types": "public-api.d.ts"
+}

package/metadata/public-api.d.ts

@@ -0,0 +1,2 @@
+export * from "./admin/admin-metadata-api";
+export * from "./metadata-api";

package/metadata/public-api.js

@@ -0,0 +1,2 @@
+export * from "./admin/admin-metadata-api";
+export * from "./metadata-api";