@contrail/entity-types 1.1.47 → 1.1.51-0

package/lib/client.d.ts

@@ -0,0 +1,97 @@
+export declare abstract class EntityReference {
+    id: string;
+    entityType: string;
+    reference: string;
+}
+export interface SortOption {
+    orderField: string;
+    order?: SortOrderOptions;
+}
+export declare enum SortOrderOptions {
+    ASC = "asc",
+    DESC = "desc"
+}
+export declare enum API_VERSION {
+    EMPTY = "",
+    V1 = "1",
+    V2 = "2"
+}
+export declare const DEFAULT_API_VERSION = API_VERSION.EMPTY;
+export declare abstract class EntitiesClientGetOptions {
+    entityName?: string;
+    id?: string;
+    reference?: string;
+    federatedId?: string;
+    federatedIds?: string[];
+    relation?: string;
+    relations?: Array<string>;
+    criteria?: {
+        [key: string]: any;
+    };
+    cacheMode?: string;
+    search?: string;
+    useSearch?: boolean;
+    order?: SortOption[];
+    skip?: number;
+    take?: number;
+    paginate?: boolean;
+    nextPageKey?: string;
+    apiVersion?: API_VERSION;
+    suffix?: string;
+}
+export declare abstract class EntitiesClientCreateOptions {
+    entityName: string;
+    object: any;
+    id?: string;
+    relation?: string;
+    apiVersion?: API_VERSION;
+    suffix?: string;
+}
+export declare abstract class EntitiesClientBatchCreateOptions {
+    entityName: string;
+    objects: any[];
+    apiVersion?: API_VERSION;
+    suffix?: string;
+}
+declare class EntitiesClientUpdateOptions {
+    entityName?: string;
+    object: any;
+    id?: string;
+    reference?: string;
+    relation?: string;
+    relationId?: string;
+    apiVersion?: API_VERSION;
+    suffix?: string;
+}
+export declare abstract class EntitiesClientBatchUpdateOptions {
+    entityName: string;
+    objects: any[];
+    apiVersion?: API_VERSION;
+    suffix?: string;
+}
+export declare abstract class EntitiesClientDeleteOptions {
+    entityName?: string;
+    id?: string;
+    reference?: string;
+    relation?: string;
+    relationId?: string;
+    apiVersion?: API_VERSION;
+    suffix?: string;
+}
+export declare abstract class EntitiesClientBatchDeleteOptions {
+    entityName?: string;
+    ids?: string[];
+    apiVersion?: API_VERSION;
+    suffix?: string;
+}
+export declare abstract class Entities {
+    abstract getAllReferences(references: Array<EntityReference>, relations: Array<string>): Promise<Map<string, any>>;
+    abstract get(options: EntitiesClientGetOptions): Promise<any | any[]>;
+    abstract create(options: EntitiesClientCreateOptions): any;
+    abstract batchCreate(options: EntitiesClientBatchCreateOptions): any;
+    abstract update(options: EntitiesClientUpdateOptions): any;
+    abstract batchUpdate(options: EntitiesClientBatchUpdateOptions): any;
+    abstract delete(options: EntitiesClientDeleteOptions): any;
+    abstract batchDelete(options: EntitiesClientBatchDeleteOptions): any;
+}
+export {};

package/lib/client.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Entities = exports.EntitiesClientBatchDeleteOptions = exports.EntitiesClientDeleteOptions = exports.EntitiesClientBatchUpdateOptions = exports.EntitiesClientBatchCreateOptions = exports.EntitiesClientCreateOptions = exports.EntitiesClientGetOptions = exports.DEFAULT_API_VERSION = exports.API_VERSION = exports.SortOrderOptions = exports.EntityReference = void 0;
+class EntityReference {
+    id;
+    entityType;
+    reference;
+}
+exports.EntityReference = EntityReference;
+var SortOrderOptions;
+(function (SortOrderOptions) {
+    SortOrderOptions["ASC"] = "asc";
+    SortOrderOptions["DESC"] = "desc";
+})(SortOrderOptions = exports.SortOrderOptions || (exports.SortOrderOptions = {}));
+var API_VERSION;
+(function (API_VERSION) {
+    API_VERSION["EMPTY"] = "";
+    API_VERSION["V1"] = "1";
+    API_VERSION["V2"] = "2";
+})(API_VERSION = exports.API_VERSION || (exports.API_VERSION = {}));
+exports.DEFAULT_API_VERSION = API_VERSION.EMPTY;
+class EntitiesClientGetOptions {
+    entityName;
+    id;
+    reference;
+    federatedId;
+    federatedIds;
+    relation;
+    relations;
+    criteria;
+    cacheMode;
+    search;
+    useSearch;
+    order;
+    skip;
+    take;
+    paginate;
+    nextPageKey;
+    apiVersion;
+    suffix;
+}
+exports.EntitiesClientGetOptions = EntitiesClientGetOptions;
+class EntitiesClientCreateOptions {
+    entityName;
+    object;
+    id;
+    relation;
+    apiVersion;
+    suffix;
+}
+exports.EntitiesClientCreateOptions = EntitiesClientCreateOptions;
+class EntitiesClientBatchCreateOptions {
+    entityName;
+    objects;
+    apiVersion;
+    suffix;
+}
+exports.EntitiesClientBatchCreateOptions = EntitiesClientBatchCreateOptions;
+class EntitiesClientUpdateOptions {
+    entityName;
+    object;
+    id;
+    reference;
+    relation;
+    relationId;
+    apiVersion;
+    suffix;
+}
+class EntitiesClientBatchUpdateOptions {
+    entityName;
+    objects;
+    apiVersion;
+    suffix;
+}
+exports.EntitiesClientBatchUpdateOptions = EntitiesClientBatchUpdateOptions;
+class EntitiesClientDeleteOptions {
+    entityName;
+    id;
+    reference;
+    relation;
+    relationId;
+    apiVersion;
+    suffix;
+}
+exports.EntitiesClientDeleteOptions = EntitiesClientDeleteOptions;
+class EntitiesClientBatchDeleteOptions {
+    entityName;
+    ids;
+    apiVersion;
+    suffix;
+}
+exports.EntitiesClientBatchDeleteOptions = EntitiesClientBatchDeleteOptions;
+class Entities {
+}
+exports.Entities = Entities;

package/lib/index.d.ts

@@ -1,24 +1,26 @@
-export * from './app-access-grant';
-export * from './app-api-key';
-export * from './app-code-package';
-export * from './app-org';
-export * from './app-version';
-export * from './app-extension-definition';
-export * from './app-extension';
-export * from './app';
-export * from './asset';
-export * from './base-managed-entity';
-export * from './content';
-export * from './contentholder-content';
-export * from './file';
-export * from './item';
-export * from './org';
-export * from './project-item';
-export * from './project';
-export * from './property-type';
-export * from './org-managed-entity';
-export * from './subscription';
-export * from './shared-links';
-export * from './type-managed-entity';
-export * from './user';
-export * from './workspace-managed-entity';
+export * from "./app-access-grant";
+export * from "./app-api-key";
+export * from "./app-code-package";
+export * from "./app-org";
+export * from "./app-version";
+export * from "./app-extension-definition";
+export * from "./app-extension";
+export * from "./app";
+export * from "./asset";
+export * from "./base-managed-entity";
+export * from "./client";
+export * from "./content";
+export * from "./contentholder-content";
+export * from "./file";
+export * from "./item";
+export * from "./loader";
+export * from "./org";
+export * from "./project-item";
+export * from "./project";
+export * from "./property-type";
+export * from "./org-managed-entity";
+export * from "./subscription";
+export * from "./shared-links";
+export * from "./type-managed-entity";
+export * from "./user";
+export * from "./workspace-managed-entity";

package/lib/index.js

@@ -24,10 +24,12 @@ __exportStar(require("./app-extension"), exports);
 __exportStar(require("./app"), exports);
 __exportStar(require("./asset"), exports);
 __exportStar(require("./base-managed-entity"), exports);
+__exportStar(require("./client"), exports);
 __exportStar(require("./content"), exports);
 __exportStar(require("./contentholder-content"), exports);
 __exportStar(require("./file"), exports);
 __exportStar(require("./item"), exports);
+__exportStar(require("./loader"), exports);
 __exportStar(require("./org"), exports);
 __exportStar(require("./project-item"), exports);
 __exportStar(require("./project"), exports);

package/lib/loader.d.ts

@@ -0,0 +1,149 @@
+import { LogLevel } from "./log-level";
+import { OrgManagedEntity } from "./org-managed-entity";
+export declare class ColumnDefinition {
+    fromProperty?: string;
+    toProperty: string;
+    conditions?: ConditionalValues[];
+    default?: any;
+}
+export declare class ConditionalValues {
+    conditional: string;
+    value: string;
+}
+export declare class AssortmentSplit {
+    partialAssortmentUpdate?: boolean;
+    dropField?: string;
+    fieldToSplitOn: string;
+    values: ValueToAssortment[];
+}
+export declare class ValueToAssortment {
+    value: string;
+    assortmentId?: string;
+    assortmentIdentifier?: string;
+}
+export interface LoaderConfiguration extends OrgManagedEntity {
+    name?: string;
+    federatedMappings?: any;
+    conditionalColumns?: ColumnDefinition[];
+    assortmentSplit?: AssortmentSplit;
+    workspaceIdentifier?: string;
+    propertiesToRemove?: string[];
+}
+export declare enum LoadStatus {
+    ACTIVE = "ACTIVE",
+    PENDING = "PENDING",
+    FAILED = "FAILED",
+    COMPLETE = "COMPLETE"
+}
+export declare enum LoadType {
+    ITEM = "ITEM",
+    PROJECT_ITEM = "PROJECT_ITEM",
+    ASSORTMENT = "ASSORTMENT",
+    COLOR = "COLOR",
+    CUSTOM_ENTITY = "CUSTOM_ENTITY",
+    SIZE_RANGE_TEMPLATE = "SIZE_RANGE_TEMPLATE"
+}
+export interface LoadResult {
+    colorsLoadResult?: ColorLoadResult;
+    itemsLoadResult?: ItemsLoadResult;
+    projectItemsLoadResult?: ProjectItemsLoadResult;
+    assortmentItemsLoadResult?: AssortmentItemsLoadResult;
+    transformErrors: any[];
+}
+export interface rowLoadError {
+    data: any;
+    error: any;
+}
+export interface LoaderNumbersSummary {
+    numberFamiliesLoaded: number;
+    numberOptionsLoaded: number;
+    numberProjectItemsLoaded: number;
+    numberAssortmentItemsLoaded: number;
+    numberColorsLoaded: number;
+    numberImagesLoaded: number;
+    numberFamiliesFailed: number;
+    numberOptionsFailed: number;
+    numberProjectItemsFailed: number;
+    numberAssortmentItemsFailed: number;
+    numberColorsFailed: number;
+    numberImagesFailed: number;
+}
+export interface ColorLoadResult {
+    colorsCreated: any[];
+    colorsUpdated: any[];
+    colorsUnchanged: any[];
+    colorsFailedCreate: rowLoadError[];
+    colorsFailedUpdate: rowLoadError[];
+    failed: boolean;
+}
+export interface ItemsLoadResult {
+    itemsCreated: any[];
+    itemsUpdated: any[];
+    itemsUnchanged: any[];
+    itemsFailedCreate: rowLoadError[];
+    itemsFailedUpdate: rowLoadError[];
+    failed: boolean;
+}
+export interface ProjectItemsLoadResult {
+    projectItemsCreated: any[];
+    projectItemsUpdated: any[];
+    projectItemsUnchanged: any[];
+    projectItemsFailedCreate: rowLoadError[];
+    projectItemsFailedUpdate: rowLoadError[];
+    failed: boolean;
+}
+export interface AssortmentItemsLoadResult {
+    assortmentItemsCreated: any[];
+    assortmentItemsUpdated: any[];
+    assortmentItemsUnchanged: any[];
+    assortmentItemsDeleted: any[];
+    assortmentItemsFailedCreate: rowLoadError[];
+    assortmentItemsFailedUpdate: rowLoadError[];
+    assortmentItemsFailedDelete: rowLoadError[];
+    failed: boolean;
+}
+export interface PreprocessingStepStoredResultSummary {
+    preprocessingStepName: string;
+    fileId: string;
+    numberOfWarnings: number;
+    numberOfErrors: number;
+}
+export declare class LoaderProcess implements OrgManagedEntity {
+    id: string;
+    createdOn?: Date;
+    updatedOn?: Date;
+    createdById?: string;
+    updatedById?: string;
+    createdBy?: any;
+    updatedBy?: any;
+    orgId?: string;
+    loaderConfigurationId?: string;
+    name?: string;
+    endedOn?: Date;
+    status: LoadStatus;
+    logLevel?: LogLevel;
+    processLogs?: string;
+    processLogS3File?: string;
+    processLogS3FileDownloadLink?: string;
+    logsFileId?: string;
+    logFileDownloadLink?: string;
+    loadProcessResult?: LoadResult;
+    loadProcessResultFileId?: string;
+    loadProcessResultDownloadLink?: string;
+    preprocessingStepResults?: PreprocessingStepStoredResultSummary[];
+    processDurationSeconds?: number;
+    loadFileId: string;
+    loadType: LoadType[];
+    federatedMappings?: any;
+    conditionalColumns?: ColumnDefinition[];
+    assortmentSplit?: AssortmentSplit;
+    partialAssortmentUpdate?: boolean;
+    assortmentItemDropField?: string;
+    workspaceIdentifier?: string;
+    propertiesToRemove?: string[];
+    badRowsCount?: number;
+    uploadErrorCount?: number;
+    hasErrors?: boolean;
+    parallelWorkerCount?: number;
+    messageGroupId?: string;
+}

package/lib/loader.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoaderProcess = exports.LoadType = exports.LoadStatus = exports.ValueToAssortment = exports.AssortmentSplit = exports.ConditionalValues = exports.ColumnDefinition = void 0;
+class ColumnDefinition {
+    fromProperty;
+    toProperty;
+    conditions;
+    default;
+}
+exports.ColumnDefinition = ColumnDefinition;
+class ConditionalValues {
+    conditional;
+    value;
+}
+exports.ConditionalValues = ConditionalValues;
+class AssortmentSplit {
+    partialAssortmentUpdate;
+    dropField;
+    fieldToSplitOn;
+    values;
+}
+exports.AssortmentSplit = AssortmentSplit;
+class ValueToAssortment {
+    value;
+    assortmentId;
+    assortmentIdentifier;
+}
+exports.ValueToAssortment = ValueToAssortment;
+var LoadStatus;
+(function (LoadStatus) {
+    LoadStatus["ACTIVE"] = "ACTIVE";
+    LoadStatus["PENDING"] = "PENDING";
+    LoadStatus["FAILED"] = "FAILED";
+    LoadStatus["COMPLETE"] = "COMPLETE";
+})(LoadStatus = exports.LoadStatus || (exports.LoadStatus = {}));
+var LoadType;
+(function (LoadType) {
+    LoadType["ITEM"] = "ITEM";
+    LoadType["PROJECT_ITEM"] = "PROJECT_ITEM";
+    LoadType["ASSORTMENT"] = "ASSORTMENT";
+    LoadType["COLOR"] = "COLOR";
+    LoadType["CUSTOM_ENTITY"] = "CUSTOM_ENTITY";
+    LoadType["SIZE_RANGE_TEMPLATE"] = "SIZE_RANGE_TEMPLATE";
+})(LoadType = exports.LoadType || (exports.LoadType = {}));
+class LoaderProcess {
+    id;
+    createdOn;
+    updatedOn;
+    createdById;
+    updatedById;
+    createdBy;
+    updatedBy;
+    orgId;
+    loaderConfigurationId;
+    name;
+    endedOn;
+    status;
+    logLevel;
+    processLogs;
+    processLogS3File;
+    processLogS3FileDownloadLink;
+    logsFileId;
+    logFileDownloadLink;
+    loadProcessResult;
+    loadProcessResultFileId;
+    loadProcessResultDownloadLink;
+    preprocessingStepResults;
+    processDurationSeconds;
+    loadFileId;
+    loadType;
+    federatedMappings;
+    conditionalColumns;
+    assortmentSplit;
+    partialAssortmentUpdate;
+    assortmentItemDropField;
+    workspaceIdentifier;
+    propertiesToRemove;
+    badRowsCount;
+    uploadErrorCount;
+    hasErrors;
+    parallelWorkerCount;
+    messageGroupId;
+}
+exports.LoaderProcess = LoaderProcess;

package/lib/log-level.d.ts

@@ -0,0 +1,8 @@
+export declare enum LogLevel {
+    FATAL = 0,
+    ERROR = 1,
+    WARN = 2,
+    INFO = 3,
+    LOG = 4,
+    DEBUG = 5
+}

package/lib/log-level.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogLevel = void 0;
+var LogLevel;
+(function (LogLevel) {
+    LogLevel[LogLevel["FATAL"] = 0] = "FATAL";
+    LogLevel[LogLevel["ERROR"] = 1] = "ERROR";
+    LogLevel[LogLevel["WARN"] = 2] = "WARN";
+    LogLevel[LogLevel["INFO"] = 3] = "INFO";
+    LogLevel[LogLevel["LOG"] = 4] = "LOG";
+    LogLevel[LogLevel["DEBUG"] = 5] = "DEBUG";
+})(LogLevel = exports.LogLevel || (exports.LogLevel = {}));

package/lib/subscription.d.ts

@@ -17,7 +17,7 @@ export declare enum SubscriptionChannel {
 export declare const SHOWCASE_APP_SUBSCRIBED_TO_CONST = "showcase-app";
 export declare const PLAN_APP_SUBSCRIBED_TO_CONST = "plan-app";
 export declare const BOARD_APP_SUBSCRIBED_TO_CONST = "board-app";
-export declare type SubscriptionMatrix = {
+export type SubscriptionMatrix = {
     [key in SubscriptionType]?: SubscriptionChannel[];
 };
 export interface Subscription extends OrgManagedEntity {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/entity-types",
-  "version": "1.1.47",
+  "version": "1.1.51-0",
   "description": "A types library for Vibeiq entities.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -21,6 +21,6 @@
     "js-yaml": "^4.1.0",
     "typedoc": "^0.25.7",
     "typedoc-plugin-extras": "^3.0.0",
-    "typescript": "^4.0.0"
+    "typescript": "^4.2"
   }
 }