@aptly-as/types - npm Package Compare versions

Comparing version 1.3.2 to 1.3.3

core/permission.d.ts

@@ -1,5 +0,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';

core/permission.ts

 
-export type AptlyPermissionGlobalModels = 'superAdmin' | 'admin' | 'default';
+export type AptlyPermissionGlobalModels = 'superAdmin' | 'admin' | 'beta' | 'default';
 
@@ -41,2 +41,3 @@ export type AptlyPermissionModules = 'projectBooking' | 'projectSupport' | 'projectRecommendations';
   | 'adminOrganizations'
+  | 'beta'
   | 'organization'
@@ -43,0 +44,0 @@ | 'organizationBooking'

enums/document.d.ts

@@ -21,1 +21,9 @@ export declare enum AptlyDocumentType {
 }
+export declare enum AptlyHistoryType {
+    Added = "added",
+    Updated = "updated",
+    Deleted = "deleted",
+    Moved = "moved",
+    Copied = "copied",
+    Imported = "imported"
+}

enums/document.js

@@ -24,2 +24,11 @@ "use strict";
 })(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

enums/document.ts

 
-
 export enum AptlyDocumentType {
@@ -22,2 +21,11 @@ Document = 'document',
   Chunk = 'chunk',
+}
+
+export enum AptlyHistoryType {
+  Added = 'added',
+  Updated = 'updated',
+  Deleted = 'deleted',
+  Moved = 'moved',
+  Copied = 'copied',
+  Imported = 'imported',
 }

models/extends.d.ts

@@ -0,1 +1,3 @@
+import { AptlyUserSchema } from './user';
+import { AptlyHistoryType } from '../enums';
 export declare type AptlyHistory = AptlyHistorySchema<string, string>;
@@ -9,6 +11,8 @@ export interface AptlyHistorySchema<ID, DATE> {
 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'>;
 }
@@ -15,0 +19,0 @@ export interface AptlyDBCrawlerCleaner {

models/extends.ts

@@ -0,1 +1,3 @@
+import { AptlyUserSchema } from './user';
+import { AptlyHistoryType } from '../enums';
 
@@ -11,6 +13,8 @@ export type AptlyHistory = AptlyHistorySchema<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'>;
 }
@@ -17,0 +21,0 @@

models/product.d.ts

 import { AptlyDBCrawlerCleaner, AptlyHistorySchema } from './extends';
 import { AptlyMediaSrcSchema } from './media';
+import { AptlyProducerSchema } from './producer';
 export declare type AptlyProduct = AptlyProductSchema<string, string>;
@@ -25,3 +26,3 @@ export interface AptlyProductSchema<ID, DATE> extends AptlyDBCrawlerCleaner, AptlyHistorySchema<ID, DATE> {
     material?: string;
-    producer?: ID;
+    producer?: ID | AptlyProducerSchema<ID, DATE>;
     supplier?: ID;
@@ -28,0 +29,0 @@ tags: ID[];

models/product.ts

 import { AptlyDBCrawlerCleaner, AptlyHistorySchema } from './extends';
 import { AptlyMediaSrcSchema } from './media';
+import { AptlyProducerSchema } from './producer';
 
@@ -26,3 +27,3 @@ export type AptlyProduct = AptlyProductSchema<string, string>;
   material?: string;
-  producer?: ID;
+  producer?: ID | AptlyProducerSchema<ID, DATE>;
   supplier?: ID;
@@ -29,0 +30,0 @@ tags: ID[];

models/recommendation.d.ts

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

models/recommendation.ts

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

models/unit-template.d.ts

@@ -5,2 +5,5 @@ import { AptlyHistorySchema } from './extends';
 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>;
@@ -37,3 +40,3 @@ export interface AptlyUnitTemplateBaseSchema<ID, DATE> {
     size?: number;
-    upsellTemplate?: ID | null;
+    upsellTemplate?: AptlyUpsellTemplateSchema<ID, DATE> | ID | null;
     _order_sections: ID[];
@@ -58,3 +61,3 @@ sections: AptlyUnitTemplateCategorySectionSchema<ID, DATE>[];
     products: AptlyUnitTemplateCategorySectionProductSchema<ID, DATE>[];
-    period: ID;
+    period: AptlyProjectPeriodSchema<ID, DATE> | ID;
 }
@@ -66,5 +69,7 @@ export declare type AptlyUnitTemplateCategorySectionPackage = AptlyUnitTemplateCategorySectionPackageSchema<string, string>;
     standard: boolean;
-    image?: string;
+    image?: string | null;
+    imageMedia?: AptlyMediaSrcSchema<ID, DATE> | null;
     description?: string;
     _product_order?: ID[];
+    products?: AptlyUnitTemplateCategorySectionProductSchema<ID, DATE>[];
 }
@@ -86,3 +91,3 @@ export declare type AptlyUnitTemplateCategorySectionProduct = AptlyUnitTemplateCategorySectionProductSchema<string, string>;
     unitCost?: number;
-    algorithm: ID;
+    algorithm: AptlyProjectAlgorithmSchema<ID, DATE> | ID;
     standard: boolean;
@@ -89,0 +94,0 @@ standardVariant?: ID;

models/unit-template.ts

@@ -8,2 +8,5 @@ import { AptlyHistorySchema } from './extends';
 import { AptlyProducerSchema } from './producer';
+import { AptlyMediaSrcSchema } from './media';
+import { AptlyUpsellTemplateSchema } from './upsell-template';
+import { AptlyProjectAlgorithmSchema, AptlyProjectPeriodSchema } from './project';
 
@@ -45,3 +48,3 @@ export type AptlyUnitTemplateBase = AptlyUnitTemplateBaseSchema<string, string>;
   size?: number;
-  upsellTemplate?: ID | null;
+  upsellTemplate?: AptlyUpsellTemplateSchema<ID, DATE> | ID | null;
   _order_sections: ID[];
@@ -68,3 +71,3 @@ sections: AptlyUnitTemplateCategorySectionSchema<ID, DATE>[];
   products: AptlyUnitTemplateCategorySectionProductSchema<ID, DATE>[];
-  period: ID;
+  period: AptlyProjectPeriodSchema<ID, DATE> | ID;
 }
@@ -77,5 +80,7 @@
   standard: boolean;
-  image?: string;
+  image?: string | null;
+  imageMedia?: AptlyMediaSrcSchema<ID, DATE> | null;
   description?: string;
   _product_order?: ID[];
+  products?: AptlyUnitTemplateCategorySectionProductSchema<ID, DATE>[];
 }
@@ -98,3 +103,3 @@
   unitCost?: number;
-  algorithm: ID;
+  algorithm: AptlyProjectAlgorithmSchema<ID, DATE> | ID;
   standard: boolean;
@@ -101,0 +106,0 @@ standardVariant?: ID;

package.json

 {
   "name": "@aptly-as/types",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "description": "Aptly types and enums",
@@ -5,0 +5,0 @@ "main": "./index.js",

No alert changes

Improved metrics

Total package byte prevSize

114413

increased by2.21%

Lines of code

3088

increased by1.51%

No dependency changes