@contrail/entity-types 1.1.6

package/README.md

@@ -0,0 +1,12 @@
+# Types Entity
+
+This module includes type definitions for VibeIQ's core types.
+
+### Usage
+```js
+import Item from '@contrail/entity-types';
+
+interface MyItem extends Item {
+  myCustomProp: string;
+}
+```

package/lib/app-api-key.d.ts

@@ -0,0 +1,15 @@
+import { OrgManagedEntity } from "@contrail/core-types";
+import { AppOrg } from "./app-org";
+export interface AppApiKey extends OrgManagedEntity {
+    id: string;
+    createdOn?: Date;
+    updatedOn?: Date;
+    createdById?: string;
+    updatedById?: string;
+    createdBy?: any;
+    updatedBy?: any;
+    orgId?: string;
+    appOrgId?: string;
+    appOrg?: AppOrg;
+    apiKey?: string;
+}

package/lib/app-api-key.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/app-code-package.d.ts

@@ -0,0 +1,17 @@
+import { App } from './app';
+import { BaseManagedEntity } from '@contrail/core-types';
+export interface AppCodePackage extends BaseManagedEntity {
+    id: string;
+    createdOn?: Date;
+    updatedOn?: Date;
+    createdById?: string;
+    updatedById?: string;
+    createdBy?: any;
+    updatedBy?: any;
+    orgId?: string;
+    appId?: string;
+    app?: App;
+    s3Location?: string;
+    uploadURL?: string;
+    downloadURL?: string;
+}

package/lib/app-code-package.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/app-org.d.ts

@@ -0,0 +1,20 @@
+import { OrgManagedEntity } from "@contrail/core-types";
+import { App } from "./app";
+import { AppVersion } from "./app-version";
+import { AppApiKey } from './app-api-key';
+export declare enum AppOrgStatus {
+    INSTALLING = "INSTALLING",
+    FAILED_INSTALLING = "FAILED_INSTALLING",
+    READY = "READY",
+    DELETING = "DELETING",
+    FAILED_DELETING = "FAILED_DELETING"
+}
+export interface AppOrg extends OrgManagedEntity {
+    status: AppOrgStatus;
+    appId?: string;
+    app?: App;
+    appVersionId?: string;
+    appVersion?: AppVersion;
+    apiKey?: AppApiKey;
+    appConfig?: any;
+}

package/lib/app-org.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppOrgStatus = void 0;
+var AppOrgStatus;
+(function (AppOrgStatus) {
+    AppOrgStatus["INSTALLING"] = "INSTALLING";
+    AppOrgStatus["FAILED_INSTALLING"] = "FAILED_INSTALLING";
+    AppOrgStatus["READY"] = "READY";
+    AppOrgStatus["DELETING"] = "DELETING";
+    AppOrgStatus["FAILED_DELETING"] = "FAILED_DELETING";
+})(AppOrgStatus = exports.AppOrgStatus || (exports.AppOrgStatus = {}));

package/lib/app-version.d.ts

@@ -0,0 +1,45 @@
+import { BaseManagedEntity } from "@contrail/core-types";
+import { App } from "./app";
+import { AppCodePackage } from "./app-code-package";
+import { PropertyType } from "./property-type";
+import { AppOrg } from "./app-org";
+export declare enum AppVersionStatus {
+    PUBLISHING = "PUBLISHING",
+    FAILED_PUBLISHING = "FAILED_PUBLISHING",
+    PUBLISHED = "PUBLISHED",
+    ARCHIVING = "ARCHIVING",
+    FAILED_ARCHIVING = "FAILED_ARCHIVING",
+    ARCHIVED = "ARCHIVED"
+}
+export declare enum AppRuntime {
+    DOCKER = "DOCKER",
+    NODE = "NODE"
+}
+export interface AppVersion extends BaseManagedEntity {
+    orgId?: string;
+    appId?: string;
+    app?: App;
+    appOrgs?: AppOrg[];
+    versionNumber: number;
+    status: AppVersionStatus;
+    eventWorkflowTriggerKeyMapping: string;
+    configProperties?: ConfigProperty[];
+    triggerKeyDefinitions?: TriggerKeyDefinition[];
+    dockerImageRef?: string;
+    appCodePackageId?: string;
+    appCodePackage?: AppCodePackage;
+    appRuntime?: AppRuntime;
+    frameworkVersion?: number;
+}
+export declare class ConfigProperty {
+    slug: string;
+    propertyType: PropertyType;
+    options?: any[];
+    label: string;
+}
+export declare class TriggerKeyDefinition {
+    name: string;
+    description?: string;
+    triggerKey: string;
+    external?: boolean;
+}

package/lib/app-version.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TriggerKeyDefinition = exports.ConfigProperty = exports.AppRuntime = exports.AppVersionStatus = void 0;
+var AppVersionStatus;
+(function (AppVersionStatus) {
+    AppVersionStatus["PUBLISHING"] = "PUBLISHING";
+    AppVersionStatus["FAILED_PUBLISHING"] = "FAILED_PUBLISHING";
+    AppVersionStatus["PUBLISHED"] = "PUBLISHED";
+    AppVersionStatus["ARCHIVING"] = "ARCHIVING";
+    AppVersionStatus["FAILED_ARCHIVING"] = "FAILED_ARCHIVING";
+    AppVersionStatus["ARCHIVED"] = "ARCHIVED";
+})(AppVersionStatus = exports.AppVersionStatus || (exports.AppVersionStatus = {}));
+var AppRuntime;
+(function (AppRuntime) {
+    AppRuntime["DOCKER"] = "DOCKER";
+    AppRuntime["NODE"] = "NODE";
+})(AppRuntime = exports.AppRuntime || (exports.AppRuntime = {}));
+class ConfigProperty {
+    slug;
+    propertyType;
+    options;
+    label;
+}
+exports.ConfigProperty = ConfigProperty;
+class TriggerKeyDefinition {
+    name;
+    description;
+    triggerKey;
+    external;
+}
+exports.TriggerKeyDefinition = TriggerKeyDefinition;

package/lib/app.d.ts

@@ -0,0 +1,26 @@
+import { BaseManagedEntity } from "@contrail/core-types";
+import { AppCodePackage } from "./app-code-package";
+import { AppOrg } from "./app-org";
+import { AppVersion, ConfigProperty, TriggerKeyDefinition, AppRuntime } from "./app-version";
+export interface App extends BaseManagedEntity {
+    name: string;
+    identifier: string;
+    installable?: boolean;
+    latestAppVersionId?: string;
+    latestAppVersion?: AppVersion;
+    thumbnail?: string;
+    description?: string;
+    publisher: string;
+    public: boolean;
+    hidden?: boolean;
+    privateOrgId?: string;
+    eventWorkflowTriggerKeyMapping: string;
+    configProperties?: ConfigProperty[];
+    appOrgs?: AppOrg[];
+    triggerKeyDefinitions?: TriggerKeyDefinition[];
+    dockerImageRef?: string;
+    appCodePackageId?: string;
+    appCodePackage?: AppCodePackage;
+    appRuntime?: AppRuntime;
+    frameworkVersion?: number;
+}

package/lib/app.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/asset.d.ts

@@ -0,0 +1,16 @@
+import { TypeManagedEntity } from "@contrail/core-types";
+import { Content } from './content';
+export interface Asset extends TypeManagedEntity {
+    workspaceId?: string;
+    name?: string;
+    contentId: string;
+    content?: Content;
+    copyFileId?: string;
+    fileName?: string;
+    contentType?: string;
+    fileSize?: string;
+    largeViewableDownloadUrl?: string;
+    mediumViewableDownloadUrl?: string;
+    smallViewableDownloadUrl?: string;
+    tinyViewableDownloadUrl?: string;
+}

package/lib/asset.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/content.d.ts

@@ -0,0 +1,25 @@
+import { BaseManagedEntity } from '@contrail/core-types';
+import { ContentHolderContent } from './contentholder-content';
+export interface Content extends BaseManagedEntity {
+    assetId?: string;
+    fileName?: string;
+    contentType?: string;
+    fileSize?: string;
+    primaryFileId?: string;
+    primaryFileUrl?: string;
+    largeViewableId?: string;
+    largeViewableUrl?: string;
+    mediumViewableId?: string;
+    mediumViewableUrl?: string;
+    smallViewableId?: string;
+    smallViewableUrl?: string;
+    tinyViewableId?: string;
+    tinyViewableUrl?: string;
+    federatedId?: string;
+    ownerType?: string;
+    ownerFederatedId?: string;
+    primaryViewable?: boolean;
+    primaryFile?: any;
+    copyFileId?: string[];
+    contentHolderContent?: ContentHolderContent;
+}

package/lib/content.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/contentholder-content.d.ts

@@ -0,0 +1,5 @@
+import { OrgManagedEntity } from "@contrail/core-types";
+export interface ContentHolderContent extends OrgManagedEntity {
+    contentHolderReference?: string;
+    contentId?: string;
+}

package/lib/contentholder-content.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/file.d.ts

@@ -0,0 +1,14 @@
+import { OrgManagedEntity } from '@contrail/core-types';
+export interface File extends OrgManagedEntity {
+    ownedByReference?: string;
+    fileKey: string;
+    fileBucket: string;
+    fileSize: string;
+    fileName: string;
+    contentType: string;
+    fileUrl: string;
+    uploaded: boolean;
+    downloadUrl: string;
+    uploadPost: any;
+    ttl?: number;
+}

package/lib/file.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/index.d.ts

@@ -0,0 +1 @@
+export * from './item';

package/lib/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./item"), exports);

package/lib/item.d.ts

@@ -0,0 +1,20 @@
+import { TypeManagedEntity } from '@contrail/core-types';
+export interface Item extends TypeManagedEntity {
+    itemFamilyId?: string;
+    itemFamily?: Item;
+    itemOptions?: {
+        [key: string]: Array<Item>;
+    };
+    name: string;
+    primaryViewableId?: string;
+    federatedId?: string;
+    assortmentItems?: any[];
+    assortmentAtts?: {
+        [key: string]: any;
+    };
+    optionGroup?: string;
+    optionName?: string;
+    isPrimary?: boolean;
+    roles?: Array<string>;
+    [key: string]: any;
+}

package/lib/item.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/project-item.d.ts

@@ -0,0 +1,9 @@
+import { TypeManagedEntity } from '@contrail/core-types';
+import { Project } from './project';
+export interface ProjectItem extends TypeManagedEntity {
+    projectId?: string;
+    project?: Project;
+    itemId?: string;
+    item?: any;
+    roles?: Array<string>;
+}

package/lib/project-item.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/project.d.ts

@@ -0,0 +1,4 @@
+import { OrgManagedEntity } from "@contrail/core-types";
+export interface Project extends OrgManagedEntity {
+    name: string;
+}

package/lib/project.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/property-type.d.ts

@@ -0,0 +1,31 @@
+export declare enum PropertyType {
+    Text = "text",
+    String = "string",
+    Number = "number",
+    Date = "date",
+    Boolean = "boolean",
+    MultiSelect = "multi_select",
+    SingleSelect = "choice",
+    Url = "url",
+    Currency = "currency",
+    Percent = "percent",
+    Rating = "rating",
+    Formula = "formula",
+    ObjectReference = "object_reference",
+    ObjectReferenceList = "object_ref_list",
+    DataGrid = "data_grid",
+    CascadingSelect = "cascading_select",
+    Sequence = "sequence",
+    Constant = "constant",
+    Composite = "composite",
+    UserList = "userList",
+    Image = "image",
+    Json = "json"
+}
+export interface PropertyTypeMetaData {
+    label: string;
+    propertyType: PropertyType;
+    createable?: boolean;
+}
+export declare const AllPropertyTypes: Array<PropertyTypeMetaData>;
+export declare const PropertyTypeMeta: Map<PropertyType, PropertyTypeMetaData>;

package/lib/property-type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@contrail/entity-types",
+  "version": "1.1.6",
+  "description": "A types library for Vibeiq entities.",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
+    "lint": "tslint -p tsconfig.json",
+    "test": "jest"
+  },
+  "keywords": [
+    "VibeIQ",
+    "contrail"
+  ],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@contrail/core-types": "^1.0.6"
+  },
+  "devDependencies": {
+    "@types/node": "^18.15.11",
+    "jest": "^23.6.0",
+    "js-yaml": "^4.1.0",
+    "ts-jest": "^23.10.5",
+    "typescript": "^4.0.0"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".spec.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}