@aptly-as/types 1.3.2 → 1.3.3

package/core/permission.d.ts

@@ -1,5 +1,5 @@
-export declare type AptlyPermissionGlobalModels = 'superAdmin' | 'admin' | 'default';
+export declare type AptlyPermissionGlobalModels = 'superAdmin' | 'admin' | 'beta' | 'default';
 export declare type AptlyPermissionModules = 'projectBooking' | 'projectSupport' | 'projectRecommendations';
 export declare type AptlyPermissionModulesModels = 'default' | 'core' | 'algorithms' | 'booking' | 'unitExtraOptions' | 'unitExtraFields' | 'pages' | 'recommendations' | 'subcontractor' | 'optionLabels' | 'support' | 'testing';
 export declare type AptlyPermissionOrganizationModels = 'testingAdmin' | 'admin' | 'content' | 'reports' | 'support' | 'thirdParty' | 'default';
-export declare type AptlyPermissionModels = 'admin' | 'adminBilling' | 'adminProducers' | 'adminProducts' | 'adminReport' | 'adminStats' | 'adminSuppliers' | 'adminTags' | 'adminTesting' | 'adminUsers' | 'adminOrganizations' | 'organization' | 'organizationBooking' | 'organizationClients' | 'organizationMembers' | 'organizationOptionLabels' | 'organizationProducts' | 'organizationReport' | 'organizationStats' | 'organizationLogo' | 'organizationWebhooks' | 'project' | 'projectAlgorithms' | 'projectBooking' | 'projectDocuments' | 'projectInquiry' | 'projectOrders' | 'projectPages' | 'projectPeriods' | 'projectProducts' | 'projectRecommendations' | 'projectReport' | 'projectReportPrice' | 'projectTheme' | 'projectSigning' | 'projectSubcontractor' | 'projectUnits' | 'projectUnitInvites' | 'projectUnitExtraFields' | 'projectUnitExtraOptions' | 'projectUnitTemplates' | 'projectUnitTemplatesAlgorithms' | 'projectUnitTemplatesPrices' | 'projectUpsellTemplates' | 'unit' | 'unitBooking' | 'unitInquiry' | 'unitOrders' | 'unitPages' | 'unitProducts' | 'unitReport';
+export declare type AptlyPermissionModels = 'admin' | 'adminBilling' | 'adminProducers' | 'adminProducts' | 'adminReport' | 'adminStats' | 'adminSuppliers' | 'adminTags' | 'adminTesting' | 'adminUsers' | 'adminOrganizations' | 'beta' | 'organization' | 'organizationBooking' | 'organizationClients' | 'organizationMembers' | 'organizationOptionLabels' | 'organizationProducts' | 'organizationReport' | 'organizationStats' | 'organizationLogo' | 'organizationWebhooks' | 'project' | 'projectAlgorithms' | 'projectBooking' | 'projectDocuments' | 'projectInquiry' | 'projectOrders' | 'projectPages' | 'projectPeriods' | 'projectProducts' | 'projectRecommendations' | 'projectReport' | 'projectReportPrice' | 'projectTheme' | 'projectSigning' | 'projectSubcontractor' | 'projectUnits' | 'projectUnitInvites' | 'projectUnitExtraFields' | 'projectUnitExtraOptions' | 'projectUnitTemplates' | 'projectUnitTemplatesAlgorithms' | 'projectUnitTemplatesPrices' | 'projectUpsellTemplates' | 'unit' | 'unitBooking' | 'unitInquiry' | 'unitOrders' | 'unitPages' | 'unitProducts' | 'unitReport';

package/core/permission.ts

@@ -1,5 +1,5 @@
 
-export type AptlyPermissionGlobalModels = 'superAdmin' | 'admin' | 'default';
+export type AptlyPermissionGlobalModels = 'superAdmin' | 'admin' | 'beta' | 'default';
 
 export type AptlyPermissionModules = 'projectBooking' | 'projectSupport' | 'projectRecommendations';
 
@@ -38,6 +38,7 @@ export type AptlyPermissionModels =
   | 'adminTesting'
   | 'adminUsers'
   | 'adminOrganizations'
+  | 'beta'
   | 'organization'
   | 'organizationBooking'
   | 'organizationClients'

package/enums/document.d.ts

@@ -18,3 +18,11 @@ export declare enum AptlyDocumentType {
     Contract = "contract",
     Chunk = "chunk"
 }
+export declare enum AptlyHistoryType {
+    Added = "added",
+    Updated = "updated",
+    Deleted = "deleted",
+    Moved = "moved",
+    Copied = "copied",
+    Imported = "imported"
+}

package/enums/document.js

@@ -21,4 +21,13 @@ var AptlyDocumentType;
     AptlyDocumentType["Contract"] = "contract";
     AptlyDocumentType["Chunk"] = "chunk";
 })(AptlyDocumentType = exports.AptlyDocumentType || (exports.AptlyDocumentType = {}));
+var AptlyHistoryType;
+(function (AptlyHistoryType) {
+    AptlyHistoryType["Added"] = "added";
+    AptlyHistoryType["Updated"] = "updated";
+    AptlyHistoryType["Deleted"] = "deleted";
+    AptlyHistoryType["Moved"] = "moved";
+    AptlyHistoryType["Copied"] = "copied";
+    AptlyHistoryType["Imported"] = "imported";
+})(AptlyHistoryType = exports.AptlyHistoryType || (exports.AptlyHistoryType = {}));
 //# sourceMappingURL=document.js.map

package/enums/document.js.map

@@ -1 +1 @@
-{"version":3,"file":"document.js","sourceRoot":"","sources":["document.ts"],"names":[],"mappings":";;AAEA,IAAY,iBAmBX;AAnBD,WAAY,iBAAiB;IAC3B,0CAAqB,CAAA;IACrB,0CAAqB,CAAA;IACrB,4CAAuB,CAAA;IACvB,8CAAyB,CAAA;IACzB,wDAAmC,CAAA;IACnC,gCAAW,CAAA;IACX,sCAAiB,CAAA;IACjB,sDAAiC,CAAA;IACjC,wCAAmB,CAAA;IACnB,4DAAuC,CAAA;IACvC,oDAA+B,CAAA;IAC/B,wDAAmC,CAAA;IACnC,0DAAqC,CAAA;IACrC,sCAAiB,CAAA;IACjB,0CAAqB,CAAA;IACrB,4CAAuB,CAAA;IACvB,0CAAqB,CAAA;IACrB,oCAAe,CAAA;AACjB,CAAC,EAnBW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAmB5B"}
+{"version":3,"file":"document.js","sourceRoot":"","sources":["document.ts"],"names":[],"mappings":";;AACA,IAAY,iBAmBX;AAnBD,WAAY,iBAAiB;IAC3B,0CAAqB,CAAA;IACrB,0CAAqB,CAAA;IACrB,4CAAuB,CAAA;IACvB,8CAAyB,CAAA;IACzB,wDAAmC,CAAA;IACnC,gCAAW,CAAA;IACX,sCAAiB,CAAA;IACjB,sDAAiC,CAAA;IACjC,wCAAmB,CAAA;IACnB,4DAAuC,CAAA;IACvC,oDAA+B,CAAA;IAC/B,wDAAmC,CAAA;IACnC,0DAAqC,CAAA;IACrC,sCAAiB,CAAA;IACjB,0CAAqB,CAAA;IACrB,4CAAuB,CAAA;IACvB,0CAAqB,CAAA;IACrB,oCAAe,CAAA;AACjB,CAAC,EAnBW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAmB5B;AAED,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,mCAAe,CAAA;IACf,uCAAmB,CAAA;IACnB,uCAAmB,CAAA;IACnB,mCAAe,CAAA;IACf,qCAAiB,CAAA;IACjB,yCAAqB,CAAA;AACvB,CAAC,EAPW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAO3B"}

package/enums/document.ts

@@ -1,5 +1,4 @@
 
-
 export enum AptlyDocumentType {
   Document = 'document',
   UnitPlan = 'unitPlan',
@@ -19,4 +18,13 @@ export enum AptlyDocumentType {
   EndReport = 'endReport',
   Contract = 'contract',
   Chunk = 'chunk',
+}
+
+export enum AptlyHistoryType {
+  Added = 'added',
+  Updated = 'updated',
+  Deleted = 'deleted',
+  Moved = 'moved',
+  Copied = 'copied',
+  Imported = 'imported',
 }

package/models/extends.d.ts

@@ -1,3 +1,5 @@
+import { AptlyUserSchema } from './user';
+import { AptlyHistoryType } from '../enums';
 export declare type AptlyHistory = AptlyHistorySchema<string, string>;
 export interface AptlyHistorySchema<ID, DATE> {
     locked: boolean;
@@ -6,10 +8,12 @@ export interface AptlyHistorySchema<ID, DATE> {
 }
 export declare type AptlyHistoryHistory = AptlyHistoryHistorySchema<string, string>;
 export interface AptlyHistoryHistorySchema<ID, DATE> {
+    _id: ID;
+    type: AptlyHistoryType;
     referenceDate: DATE;
     diffDate: DATE;
     diff: object;
-    user: ID;
+    user: ID | Pick<AptlyUserSchema<ID, DATE>, '_id' | 'fullName'>;
 }
 export interface AptlyDBCrawlerCleaner {
     dontClean?: boolean;

package/models/extends.ts

@@ -1,3 +1,5 @@
+import { AptlyUserSchema } from './user';
+import { AptlyHistoryType } from '../enums';
 
 export type AptlyHistory = AptlyHistorySchema<string, string>;
 export interface AptlyHistorySchema<ID, DATE> {
@@ -8,10 +10,12 @@ export interface AptlyHistorySchema<ID, DATE> {
 
 export type AptlyHistoryHistory = AptlyHistoryHistorySchema<string, string>;
 export interface AptlyHistoryHistorySchema<ID, DATE> {
+  _id: ID;
+  type: AptlyHistoryType;
   referenceDate: DATE;
   diffDate: DATE;
   diff: object;
-  user: ID;
+  user: ID | Pick<AptlyUserSchema<ID, DATE>, '_id' | 'fullName'>;
 }
 
 export interface AptlyDBCrawlerCleaner {

package/models/product.d.ts

@@ -1,5 +1,6 @@
 import { AptlyDBCrawlerCleaner, AptlyHistorySchema } from './extends';
 import { AptlyMediaSrcSchema } from './media';
+import { AptlyProducerSchema } from './producer';
 export declare type AptlyProduct = AptlyProductSchema<string, string>;
 export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, AptlyHistorySchema<ID, DATE> {
     _id: ID;
@@ -22,7 +23,7 @@ export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, Apt
     height?: string;
     length?: string;
     material?: string;
-    producer?: ID;
+    producer?: ID | AptlyProducerSchema<ID, DATE>;
     supplier?: ID;
     tags: ID[];
     documents: ID[];

package/models/product.ts

@@ -1,5 +1,6 @@
 import { AptlyDBCrawlerCleaner, AptlyHistorySchema } from './extends';
 import { AptlyMediaSrcSchema } from './media';
+import { AptlyProducerSchema } from './producer';
 
 export type AptlyProduct = AptlyProductSchema<string, string>;
 export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, AptlyHistorySchema<ID, DATE> {
@@ -23,7 +24,7 @@ export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, Apt
   height?: string;
   length?: string;
   material?: string;
-  producer?: ID;
+  producer?: ID | AptlyProducerSchema<ID, DATE>;
   supplier?: ID;
   tags: ID[];
   documents: ID[];

package/models/recommendation.d.ts

@@ -1,4 +1,4 @@
-import { AptlyMediaSrc } from './media';
+import { AptlyMediaSrcSchema } from './media';
 export declare type AptlyRecommendation = AptlyRecommendationSchema<string, string>;
 export interface AptlyRecommendationSchema<ID, DATE> {
     _id: ID;
@@ -9,6 +9,6 @@ export interface AptlyRecommendationSchema<ID, DATE> {
     color: string;
     text: string;
     image?: string | null;
-    imageMedia?: AptlyMediaSrc | null;
+    imageMedia?: AptlyMediaSrcSchema<ID, DATE> | null;
     archived?: boolean;
 }

package/models/recommendation.ts

@@ -1,4 +1,4 @@
-import { AptlyMediaSrc } from './media';
+import { AptlyMediaSrcSchema } from './media';
 
 export type AptlyRecommendation = AptlyRecommendationSchema<string, string>;
 export interface AptlyRecommendationSchema<ID, DATE> {
@@ -10,6 +10,6 @@ export interface AptlyRecommendationSchema<ID, DATE> {
   color: string;
   text: string;
   image?: string | null;
-  imageMedia?: AptlyMediaSrc | null;
+  imageMedia?: AptlyMediaSrcSchema<ID, DATE> | null;
   archived?: boolean;
 }

package/models/unit-template.d.ts

@@ -2,6 +2,9 @@ import { AptlyHistorySchema } from './extends';
 import { AptlyCategorySectionDisplayType, AptlyUnitTemplateCategorySectionProductMeasureUnitType, AptlyUnitTemplateCategorySectionProductParamKey } from '../enums';
 import { AptlyProductSchema } from './product';
 import { AptlyProducerSchema } from './producer';
+import { AptlyMediaSrcSchema } from './media';
+import { AptlyUpsellTemplateSchema } from './upsell-template';
+import { AptlyProjectAlgorithmSchema, AptlyProjectPeriodSchema } from './project';
 export declare type AptlyUnitTemplateBase = AptlyUnitTemplateBaseSchema<string, string>;
 export interface AptlyUnitTemplateBaseSchema<ID, DATE> {
     _id: ID;
@@ -33,7 +36,7 @@ export interface AptlyUnitTemplateCategorySchema<ID, DATE> {
     text?: string;
     isRoom: boolean;
     size?: number;
-    upsellTemplate?: ID | null;
+    upsellTemplate?: AptlyUpsellTemplateSchema<ID, DATE> | ID | null;
     _order_sections: ID[];
     sections: AptlyUnitTemplateCategorySectionSchema<ID, DATE>[];
     /**
@@ -53,16 +56,18 @@ export interface AptlyUnitTemplateCategorySectionSchema<ID, DATE> {
     packages: AptlyUnitTemplateCategorySectionPackageSchema<ID, DATE>[];
     _order_products: ID[];
     products: AptlyUnitTemplateCategorySectionProductSchema<ID, DATE>[];
-    period: ID;
+    period: AptlyProjectPeriodSchema<ID, DATE> | ID;
 }
 export declare type AptlyUnitTemplateCategorySectionPackage = AptlyUnitTemplateCategorySectionPackageSchema<string, string>;
 export interface AptlyUnitTemplateCategorySectionPackageSchema<ID, DATE> {
     _id: ID;
     name: string;
     standard: boolean;
-    image?: string;
+    image?: string | null;
+    imageMedia?: AptlyMediaSrcSchema<ID, DATE> | null;
     description?: string;
     _product_order?: ID[];
+    products?: AptlyUnitTemplateCategorySectionProductSchema<ID, DATE>[];
 }
 export declare type AptlyUnitTemplateCategorySectionProduct = AptlyUnitTemplateCategorySectionProductSchema<string, string>;
 export interface AptlyUnitTemplateCategorySectionProductSchema<ID, DATE> {
@@ -79,7 +84,7 @@ export interface AptlyUnitTemplateCategorySectionProductSchema<ID, DATE> {
     consequenceParam?: string;
     amount: number;
     unitCost?: number;
-    algorithm: ID;
+    algorithm: AptlyProjectAlgorithmSchema<ID, DATE> | ID;
     standard: boolean;
     standardVariant?: ID;
     partOfPackage?: ID;

package/models/unit-template.ts

@@ -5,6 +5,9 @@ import {
 } from '../enums';
 import { AptlyProductSchema } from './product';
 import { AptlyProducerSchema } from './producer';
+import { AptlyMediaSrcSchema } from './media';
+import { AptlyUpsellTemplateSchema } from './upsell-template';
+import { AptlyProjectAlgorithmSchema, AptlyProjectPeriodSchema } from './project';
 
 export type AptlyUnitTemplateBase = AptlyUnitTemplateBaseSchema<string, string>;
 export interface AptlyUnitTemplateBaseSchema<ID, DATE> {
@@ -41,7 +44,7 @@ export interface AptlyUnitTemplateCategorySchema<ID, DATE> {
   text?: string;
   isRoom: boolean;
   size?: number;
-  upsellTemplate?: ID | null;
+  upsellTemplate?: AptlyUpsellTemplateSchema<ID, DATE> | ID | null;
   _order_sections: ID[];
   sections: AptlyUnitTemplateCategorySectionSchema<ID, DATE>[];
 
@@ -63,7 +66,7 @@ export interface AptlyUnitTemplateCategorySectionSchema<ID, DATE> {
   packages: AptlyUnitTemplateCategorySectionPackageSchema<ID, DATE>[];
   _order_products: ID[];
   products: AptlyUnitTemplateCategorySectionProductSchema<ID, DATE>[];
-  period: ID;
+  period: AptlyProjectPeriodSchema<ID, DATE> | ID;
 }
 
 export type AptlyUnitTemplateCategorySectionPackage = AptlyUnitTemplateCategorySectionPackageSchema<string, string>;
@@ -71,9 +74,11 @@ export interface AptlyUnitTemplateCategorySectionPackageSchema<ID, DATE> {
   _id: ID;
   name: string;
   standard: boolean;
-  image?: string;
+  image?: string | null;
+  imageMedia?: AptlyMediaSrcSchema<ID, DATE> | null;
   description?: string;
   _product_order?: ID[];
+  products?: AptlyUnitTemplateCategorySectionProductSchema<ID, DATE>[];
 }
 
 export type AptlyUnitTemplateCategorySectionProduct = AptlyUnitTemplateCategorySectionProductSchema<string, string>;
@@ -91,7 +96,7 @@ export interface AptlyUnitTemplateCategorySectionProductSchema<ID, DATE> {
   consequenceParam?: string;
   amount: number;
   unitCost?: number;
-  algorithm: ID;
+  algorithm: AptlyProjectAlgorithmSchema<ID, DATE> | ID;
   standard: boolean;
   standardVariant?: ID;
   partOfPackage?: ID;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptly-as/types",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "description": "Aptly types and enums",
   "main": "./index.js",
   "types": "./index.d.ts",