@aptly-as/types 1.12.5 → 1.15.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/core/app.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { AptlyScope } from './scope.js';
1
+ import { AptlyAppScope } from './scope.js';
2
2
  import { AptlyApp, AptlyOrganization, AptlyOrganizationAppConfig } from '../models/index.js';
3
3
  export declare enum AptlyAppSandbox {
4
4
  AllowForms = "allow-forms",
@@ -12,7 +12,7 @@ export interface AptlyAppJWT {
12
12
  exp: number;
13
13
  }
14
14
  export interface AptlyAppAuthorizeCode {
15
- scope: AptlyScope[];
15
+ scope: AptlyAppScope[];
16
16
  aud: string;
17
17
  sub: string;
18
18
  jti: string;
package/core/index.d.ts CHANGED
@@ -2,10 +2,9 @@ import { AptlyCloudinaryFile } from './cloudinary.js';
2
2
  export * from './api.js';
3
3
  export * from './app.js';
4
4
  export * from './cloudinary.js';
5
- export * from './permission.js';
5
+ export * from './scope.js';
6
6
  export * from './error.js';
7
7
  export * from './fields.js';
8
- export * from './scope.js';
9
8
  export * from './signage.js';
10
9
  export * from './webhook-event-data.js';
11
10
  export interface AptlySchemaFile extends Pick<AptlyCloudinaryFile, 'public_id' | 'url' | 'format' | 'resource_type' | 'bytes'> {
package/core/index.js CHANGED
@@ -1,9 +1,8 @@
1
1
  export * from './api.js';
2
2
  export * from './app.js';
3
3
  export * from './cloudinary.js';
4
- export * from './permission.js';
4
+ export * from './scope.js';
5
5
  export * from './error.js';
6
6
  export * from './fields.js';
7
- export * from './scope.js';
8
7
  export * from './signage.js';
9
8
  export * from './webhook-event-data.js';
package/core/scope.d.ts CHANGED
@@ -1,11 +1,113 @@
1
- import { AptlyPermissionModel } from './permission.js';
1
+ export declare enum AptlyModule {
2
+ Algorithms = "algorithms",
3
+ Booking = "booking",
4
+ Core = "core",
5
+ Default = "default",
6
+ Departments = "departments",
7
+ OptionLabels = "optionLabels",
8
+ Pages = "pages",
9
+ ProductsExtended = "productsExtended",
10
+ Recommendations = "recommendations",
11
+ Subcontractor = "subcontractor",
12
+ Support = "support",
13
+ SupportComplaint = "supportComplaint",
14
+ Testing = "testing",
15
+ UnitExtraOptions = "unitExtraOptions",
16
+ UnitExtraFields = "unitExtraFields"
17
+ }
18
+ export declare enum AptlyScope {
19
+ Admin = "admin",
20
+ AdminBilling = "adminBilling",
21
+ AdminProducers = "adminProducers",
22
+ AdminProducts = "adminProducts",
23
+ AdminReport = "adminReport",
24
+ AdminStats = "adminStats",
25
+ AdminSuppliers = "adminSuppliers",
26
+ AdminTags = "adminTags",
27
+ AdminTesting = "adminTesting",
28
+ AdminUsers = "adminUsers",
29
+ AdminOrganizations = "adminOrganizations",
30
+ Beta = "beta",
31
+ Organization = "organization",
32
+ OrganizationAlgorithms = "organizationAlgorithms",
33
+ OrganizationBooking = "organizationBooking",
34
+ OrganizationClients = "organizationClients",
35
+ OrganizationDepartments = "organizationDepartments",
36
+ OrganizationLogo = "organizationLogo",
37
+ OrganizationMembers = "organizationMembers",
38
+ OrganizationOptionLabels = "organizationOptionLabels",
39
+ OrganizationOrders = "organizationOrders",
40
+ OrganizationPages = "organizationPages",
41
+ OrganizationProducts = "organizationProducts",
42
+ OrganizationProductsExtended = "organizationProductsExtended",
43
+ OrganizationRecommendations = "organizationRecommendations",
44
+ OrganizationReport = "organizationReport",
45
+ OrganizationStats = "organizationStats",
46
+ OrganizationUnitTemplates = "organizationUnitTemplates",
47
+ OrganizationUpsellTemplates = "organizationUpsellTemplates",
48
+ OrganizationWebhooks = "organizationWebhooks",
49
+ Project = "project",
50
+ ProjectAlgorithms = "projectAlgorithms",
51
+ ProjectBooking = "projectBooking",
52
+ ProjectDocuments = "projectDocuments",
53
+ ProjectInquiry = "projectInquiry",
54
+ ProjectInquiryComplaint = "projectInquiryComplaint",
55
+ ProjectOrders = "projectOrders",
56
+ ProjectPages = "projectPages",
57
+ ProjectPeriods = "projectPeriods",
58
+ ProjectProducts = "projectProducts",
59
+ ProjectRecommendations = "projectRecommendations",
60
+ ProjectReport = "projectReport",
61
+ ProjectReportPrice = "projectReportPrice",
62
+ ProjectTheme = "projectTheme",
63
+ ProjectSigning = "projectSigning",
64
+ ProjectSubcontractor = "projectSubcontractor",
65
+ ProjectUnits = "projectUnits",
66
+ ProjectUnitInvites = "projectUnitInvites",
67
+ ProjectUnitExtraFields = "projectUnitExtraFields",
68
+ ProjectUnitExtraOptions = "projectUnitExtraOptions",
69
+ ProjectUnitTemplates = "projectUnitTemplates",
70
+ ProjectUnitTemplatesAlgorithms = "projectUnitTemplatesAlgorithms",
71
+ ProjectUnitTemplatesPrices = "projectUnitTemplatesPrices",
72
+ ProjectUpsellTemplates = "projectUpsellTemplates",
73
+ Unit = "unit",
74
+ UnitBooking = "unitBooking",
75
+ UnitInquiry = "unitInquiry",
76
+ UnitNotes = "unitNotes",
77
+ UnitOrders = "unitOrders",
78
+ UnitPages = "unitPages",
79
+ UnitProducts = "unitProducts",
80
+ UnitReport = "unitReport"
81
+ }
82
+ export declare enum AptlyUserRole {
83
+ Admin = "admin",
84
+ Beta = "beta",
85
+ Default = "default",
86
+ SuperAdmin = "superAdmin"
87
+ }
88
+ export declare enum AptlyOrganizationRole {
89
+ Admin = "admin",
90
+ Content = "content",
91
+ OrganizationContent = "organizationContent",
92
+ Default = "default",
93
+ ProjectAdmin = "projectAdmin",
94
+ TestingAdmin = "testingAdmin",
95
+ Reports = "reports",
96
+ Support = "support",
97
+ ThirdParty = "thirdParty"
98
+ }
99
+ export type AptlyScopeCrud = 'C' | 'R' | 'U' | 'D';
100
+ export type AptlyScopeSchemaValue = 'C' | 'CR' | 'CRU' | 'CRUD' | 'R' | 'RU' | 'RUD' | 'U' | 'UD' | 'D';
101
+ export type AptlyScopeSchema = {
102
+ [key in AptlyScope]: AptlyScopeSchemaValue;
103
+ };
2
104
  export declare enum AptlyScopeAction {
3
105
  Read = "read",
4
106
  Write = "write"
5
107
  }
6
- export type AptlyScope = `aptly.${AptlyPermissionModel}` | `aptly.${AptlyPermissionModel}.${AptlyScopeAction}`;
7
- export type AptlyScopeTranslations = {
8
- [key in AptlyScope]: {
108
+ export type AptlyAppScope = `aptly.${AptlyScope}` | `aptly.${AptlyScope}.${AptlyScopeAction}`;
109
+ export type AptlyAppScopeTranslations = {
110
+ [key in AptlyAppScope]: {
9
111
  label: string;
10
112
  description?: string;
11
113
  };
package/core/scope.js CHANGED
@@ -1,3 +1,105 @@
1
+ export var AptlyModule;
2
+ (function (AptlyModule) {
3
+ AptlyModule["Algorithms"] = "algorithms";
4
+ AptlyModule["Booking"] = "booking";
5
+ AptlyModule["Core"] = "core";
6
+ AptlyModule["Default"] = "default";
7
+ AptlyModule["Departments"] = "departments";
8
+ AptlyModule["OptionLabels"] = "optionLabels";
9
+ AptlyModule["Pages"] = "pages";
10
+ AptlyModule["ProductsExtended"] = "productsExtended";
11
+ AptlyModule["Recommendations"] = "recommendations";
12
+ AptlyModule["Subcontractor"] = "subcontractor";
13
+ AptlyModule["Support"] = "support";
14
+ AptlyModule["SupportComplaint"] = "supportComplaint";
15
+ AptlyModule["Testing"] = "testing";
16
+ AptlyModule["UnitExtraOptions"] = "unitExtraOptions";
17
+ AptlyModule["UnitExtraFields"] = "unitExtraFields";
18
+ })(AptlyModule || (AptlyModule = {}));
19
+ export var AptlyScope;
20
+ (function (AptlyScope) {
21
+ AptlyScope["Admin"] = "admin";
22
+ AptlyScope["AdminBilling"] = "adminBilling";
23
+ AptlyScope["AdminProducers"] = "adminProducers";
24
+ AptlyScope["AdminProducts"] = "adminProducts";
25
+ AptlyScope["AdminReport"] = "adminReport";
26
+ AptlyScope["AdminStats"] = "adminStats";
27
+ AptlyScope["AdminSuppliers"] = "adminSuppliers";
28
+ AptlyScope["AdminTags"] = "adminTags";
29
+ AptlyScope["AdminTesting"] = "adminTesting";
30
+ AptlyScope["AdminUsers"] = "adminUsers";
31
+ AptlyScope["AdminOrganizations"] = "adminOrganizations";
32
+ AptlyScope["Beta"] = "beta";
33
+ AptlyScope["Organization"] = "organization";
34
+ AptlyScope["OrganizationAlgorithms"] = "organizationAlgorithms";
35
+ AptlyScope["OrganizationBooking"] = "organizationBooking";
36
+ AptlyScope["OrganizationClients"] = "organizationClients";
37
+ AptlyScope["OrganizationDepartments"] = "organizationDepartments";
38
+ AptlyScope["OrganizationLogo"] = "organizationLogo";
39
+ AptlyScope["OrganizationMembers"] = "organizationMembers";
40
+ AptlyScope["OrganizationOptionLabels"] = "organizationOptionLabels";
41
+ AptlyScope["OrganizationOrders"] = "organizationOrders";
42
+ AptlyScope["OrganizationPages"] = "organizationPages";
43
+ AptlyScope["OrganizationProducts"] = "organizationProducts";
44
+ AptlyScope["OrganizationProductsExtended"] = "organizationProductsExtended";
45
+ AptlyScope["OrganizationRecommendations"] = "organizationRecommendations";
46
+ AptlyScope["OrganizationReport"] = "organizationReport";
47
+ AptlyScope["OrganizationStats"] = "organizationStats";
48
+ AptlyScope["OrganizationUnitTemplates"] = "organizationUnitTemplates";
49
+ AptlyScope["OrganizationUpsellTemplates"] = "organizationUpsellTemplates";
50
+ AptlyScope["OrganizationWebhooks"] = "organizationWebhooks";
51
+ AptlyScope["Project"] = "project";
52
+ AptlyScope["ProjectAlgorithms"] = "projectAlgorithms";
53
+ AptlyScope["ProjectBooking"] = "projectBooking";
54
+ AptlyScope["ProjectDocuments"] = "projectDocuments";
55
+ AptlyScope["ProjectInquiry"] = "projectInquiry";
56
+ AptlyScope["ProjectInquiryComplaint"] = "projectInquiryComplaint";
57
+ AptlyScope["ProjectOrders"] = "projectOrders";
58
+ AptlyScope["ProjectPages"] = "projectPages";
59
+ AptlyScope["ProjectPeriods"] = "projectPeriods";
60
+ AptlyScope["ProjectProducts"] = "projectProducts";
61
+ AptlyScope["ProjectRecommendations"] = "projectRecommendations";
62
+ AptlyScope["ProjectReport"] = "projectReport";
63
+ AptlyScope["ProjectReportPrice"] = "projectReportPrice";
64
+ AptlyScope["ProjectTheme"] = "projectTheme";
65
+ AptlyScope["ProjectSigning"] = "projectSigning";
66
+ AptlyScope["ProjectSubcontractor"] = "projectSubcontractor";
67
+ AptlyScope["ProjectUnits"] = "projectUnits";
68
+ AptlyScope["ProjectUnitInvites"] = "projectUnitInvites";
69
+ AptlyScope["ProjectUnitExtraFields"] = "projectUnitExtraFields";
70
+ AptlyScope["ProjectUnitExtraOptions"] = "projectUnitExtraOptions";
71
+ AptlyScope["ProjectUnitTemplates"] = "projectUnitTemplates";
72
+ AptlyScope["ProjectUnitTemplatesAlgorithms"] = "projectUnitTemplatesAlgorithms";
73
+ AptlyScope["ProjectUnitTemplatesPrices"] = "projectUnitTemplatesPrices";
74
+ AptlyScope["ProjectUpsellTemplates"] = "projectUpsellTemplates";
75
+ AptlyScope["Unit"] = "unit";
76
+ AptlyScope["UnitBooking"] = "unitBooking";
77
+ AptlyScope["UnitInquiry"] = "unitInquiry";
78
+ AptlyScope["UnitNotes"] = "unitNotes";
79
+ AptlyScope["UnitOrders"] = "unitOrders";
80
+ AptlyScope["UnitPages"] = "unitPages";
81
+ AptlyScope["UnitProducts"] = "unitProducts";
82
+ AptlyScope["UnitReport"] = "unitReport";
83
+ })(AptlyScope || (AptlyScope = {}));
84
+ export var AptlyUserRole;
85
+ (function (AptlyUserRole) {
86
+ AptlyUserRole["Admin"] = "admin";
87
+ AptlyUserRole["Beta"] = "beta";
88
+ AptlyUserRole["Default"] = "default";
89
+ AptlyUserRole["SuperAdmin"] = "superAdmin";
90
+ })(AptlyUserRole || (AptlyUserRole = {}));
91
+ export var AptlyOrganizationRole;
92
+ (function (AptlyOrganizationRole) {
93
+ AptlyOrganizationRole["Admin"] = "admin";
94
+ AptlyOrganizationRole["Content"] = "content";
95
+ AptlyOrganizationRole["OrganizationContent"] = "organizationContent";
96
+ AptlyOrganizationRole["Default"] = "default";
97
+ AptlyOrganizationRole["ProjectAdmin"] = "projectAdmin";
98
+ AptlyOrganizationRole["TestingAdmin"] = "testingAdmin";
99
+ AptlyOrganizationRole["Reports"] = "reports";
100
+ AptlyOrganizationRole["Support"] = "support";
101
+ AptlyOrganizationRole["ThirdParty"] = "thirdParty";
102
+ })(AptlyOrganizationRole || (AptlyOrganizationRole = {}));
1
103
  export var AptlyScopeAction;
2
104
  (function (AptlyScopeAction) {
3
105
  AptlyScopeAction["Read"] = "read";
@@ -18,7 +18,8 @@ export declare enum AptlyDocumentType {
18
18
  EndReport = "endReport",
19
19
  Contract = "contract",
20
20
  Chunk = "chunk",
21
- Gdpr = "gdpr"
21
+ Gdpr = "gdpr",
22
+ Zip = "zip"
22
23
  }
23
24
  export declare enum AptlyHistoryType {
24
25
  Added = "added",
package/enums/document.js CHANGED
@@ -20,6 +20,7 @@ export var AptlyDocumentType;
20
20
  AptlyDocumentType["Contract"] = "contract";
21
21
  AptlyDocumentType["Chunk"] = "chunk";
22
22
  AptlyDocumentType["Gdpr"] = "gdpr";
23
+ AptlyDocumentType["Zip"] = "zip";
23
24
  })(AptlyDocumentType || (AptlyDocumentType = {}));
24
25
  export var AptlyHistoryType;
25
26
  (function (AptlyHistoryType) {
package/models/app.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { AptlyBaseSchema } from './extends.js';
2
2
  import { AptlyWebhookType } from '../enums/index.js';
3
- import { AptlyAppSandbox, AptlyField, AptlyPermissionModel } from '../core/index.js';
3
+ import { AptlyAppSandbox, AptlyField, AptlyScope } from '../core/index.js';
4
4
  import { AptlyMediaSrcSchema } from './media.js';
5
5
  export type AptlyApp = AptlyAppSchema<string, string>;
6
6
  export interface AptlyAppSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'archived'> {
@@ -59,7 +59,7 @@ export interface AptlyAppMenuSchema<ID, DATE> {
59
59
  _id: ID;
60
60
  type: AptlyAppInjectionType;
61
61
  menu: AptlyAppInjectionMenu[];
62
- model: AptlyPermissionModel;
62
+ model: AptlyScope;
63
63
  label: string;
64
64
  icon?: AptlyMediaSrcSchema<ID, DATE>;
65
65
  src: string;
@@ -1,11 +1,11 @@
1
1
  import { AptlyBaseSchema } from './extends.js';
2
- import { AptlyPermissionSchema } from '../core/index.js';
2
+ import { AptlyScopeSchema } from '../core/index.js';
3
3
  export interface AptlyUserClientSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'archived'> {
4
4
  user: ID;
5
5
  subject: string;
6
6
  clientId: string;
7
7
  clientSecret?: string;
8
- permissions: AptlyPermissionSchema;
8
+ permissions: AptlyScopeSchema;
9
9
  created: DATE;
10
10
  }
11
11
  export type AptlyUserClient = AptlyUserClientSchema<string, string>;
@@ -1,4 +1,4 @@
1
- import { AptlyPermissionOrganizationModels } from '../core/index.js';
1
+ import { AptlyOrganizationRole } from '../core/index.js';
2
2
  import { AptlyOrganizationSchema } from './organization.js';
3
3
  import { AptlyProjectSchema } from './project.js';
4
4
  import { AptlyUserSchema } from './user.js';
@@ -22,7 +22,7 @@ export type AptlyDepartmentUser = AptlyDepartmentUserGeneric<string, string>;
22
22
  export interface AptlyDepartmentUserGeneric<ID, DATE> {
23
23
  _id: ID;
24
24
  user: ID | AptlyUserSchema<ID, DATE>;
25
- permissions: AptlyPermissionOrganizationModels[];
25
+ permissions: AptlyOrganizationRole[];
26
26
  createdAt: DATE;
27
27
  updatedAt: DATE;
28
28
  }
package/models/index.d.ts CHANGED
@@ -13,6 +13,7 @@ export * from './option-label.js';
13
13
  export * from './order.js';
14
14
  export * from './organization.js';
15
15
  export * from './page.js';
16
+ export * from './period.js';
16
17
  export * from './producer.js';
17
18
  export * from './product.js';
18
19
  export * from './product-stats.js';
package/models/index.js CHANGED
@@ -13,6 +13,7 @@ export * from './option-label.js';
13
13
  export * from './order.js';
14
14
  export * from './organization.js';
15
15
  export * from './page.js';
16
+ export * from './period.js';
16
17
  export * from './producer.js';
17
18
  export * from './product.js';
18
19
  export * from './product-stats.js';
@@ -1,4 +1,5 @@
1
- import { AptlyPermissionModulesModels, AptlyPermissionOrganizationModels, AptlyScope, AptlySignageSchema } from '../core/index.js';
1
+ import { AptlyModule } from '../core/index.js';
2
+ import { AptlyOrganizationRole, AptlyAppScope, AptlySignageSchema } from '../core/index.js';
2
3
  import { AptlyUserSchema } from './user.js';
3
4
  import { AptlyMediaSrc } from './media.js';
4
5
  import { AptlyBaseSchema, AptlyHistorySchema } from './extends.js';
@@ -29,12 +30,12 @@ export interface AptlyOrganizationSchema<ID, DATE> extends AptlyBaseSchema<ID, D
29
30
  email: string;
30
31
  algorithms: AptlyAlgorithmSchema<ID>[];
31
32
  members: AptlyOrganizationMemberSchema<ID, DATE>[];
32
- modules: AptlyPermissionModulesModels[];
33
+ modules: AptlyModule[];
33
34
  contractSign?: AptlySignageSchema<ID, DATE>;
34
35
  integrations: AptlyOrganizationIntegrationsSchema<ID>[];
35
36
  invites: AptlyOrganizationInviteSchema<ID, DATE>[];
36
37
  apps: AptlyOrganizationAppConfigSchema<ID, DATE>[];
37
- s3Bucket?: string;
38
+ storageId?: string;
38
39
  created: DATE;
39
40
  fixedVariants?: boolean;
40
41
  }
@@ -49,7 +50,7 @@ export type AptlyOrganizationMember = AptlyOrganizationMemberSchema<string, stri
49
50
  export interface AptlyOrganizationMemberSchema<ID, DATE> {
50
51
  _id: ID;
51
52
  user: AptlyUserSchema<ID, DATE> | ID;
52
- permissions: AptlyPermissionOrganizationModels[];
53
+ permissions: AptlyOrganizationRole[];
53
54
  projects?: (ID | AptlyProducerSchema<ID, DATE>)[] | null;
54
55
  departments?: (ID | AptlyDepartmentGeneric<ID, DATE>)[];
55
56
  }
@@ -58,7 +59,7 @@ export interface AptlyOrganizationInviteSchema<ID, DATE> {
58
59
  _id: ID;
59
60
  code: string;
60
61
  created: DATE;
61
- permissions?: AptlyPermissionOrganizationModels[];
62
+ permissions?: AptlyOrganizationRole[];
62
63
  projects?: ID[] | null;
63
64
  departments?: ID[] | null;
64
65
  claim: {
@@ -71,6 +72,6 @@ export interface AptlyOrganizationInviteSchema<ID, DATE> {
71
72
  export type AptlyOrganizationAppConfig<S extends object = object> = AptlyOrganizationAppConfigSchema<string, string, S>;
72
73
  export interface AptlyOrganizationAppConfigSchema<ID, DATE, S extends object = object> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
73
74
  app: ID | AptlyAppSchema<ID, DATE>;
74
- scope: AptlyScope[];
75
+ scope: AptlyAppScope[];
75
76
  settings: S;
76
77
  }
@@ -0,0 +1,8 @@
1
+ export type AptlyPeriod = AptlyPeriodSchema<string, string>;
2
+ export interface AptlyPeriodSchema<ID, DATE> {
3
+ _id: ID;
4
+ name: string;
5
+ open: DATE;
6
+ close: DATE;
7
+ override?: boolean;
8
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -1,5 +1,7 @@
1
+ import { AptlyAlgorithm, AptlyAlgorithmPipeline, AptlyAlgorithmPipelineSchema, AptlyAlgorithmSchema } from './algorithm.js';
1
2
  import { AptlyOrganizationSchema } from './organization.js';
2
- import { AptlyPermissionModulesModels } from '../core/index.js';
3
+ import { AptlyModule } from '../core/index.js';
4
+ import { AptlyPeriod, AptlyPeriodSchema } from './period.js';
3
5
  import { AptlyUserSchema } from './user.js';
4
6
  import { AptlyBaseSchema, AptlyHistorySchema } from './extends.js';
5
7
  import { AptlyDocumentSchema } from './document.js';
@@ -10,8 +12,8 @@ export interface AptlyProjectSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE>,
10
12
  organization: AptlyOrganizationSchema<ID, DATE> | ID;
11
13
  template?: ID | null;
12
14
  customers: ID[];
13
- periods: AptlyProjectPeriodSchema<ID, DATE>[];
14
- algorithms: AptlyProjectAlgorithmSchema<ID>[];
15
+ periods: AptlyPeriodSchema<ID, DATE>[];
16
+ algorithms: AptlyAlgorithmSchema<ID>[];
15
17
  documents: AptlyDocumentSchema<ID, DATE>[];
16
18
  pages: ID[];
17
19
  myPageText?: string;
@@ -19,36 +21,18 @@ export interface AptlyProjectSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE>,
19
21
  notify: AptlyProjectNotifySchema<ID, DATE>[];
20
22
  theme: AptlyProjectTheme;
21
23
  integrations: AptlyProjectIntegrationSchema<ID>[];
22
- disabledModules?: AptlyPermissionModulesModels[];
24
+ disabledModules?: AptlyModule[];
23
25
  extraOptions?: AptlyUnitOptionExtraItemSchema<ID, DATE>[];
24
- s3Bucket?: string;
25
26
  gdprActive?: boolean;
27
+ userFavorites?: ID[];
26
28
  created: DATE;
27
29
  }
28
- export type AptlyProjectPeriod = AptlyProjectPeriodSchema<string, string>;
29
- export interface AptlyProjectPeriodSchema<ID, DATE> {
30
- _id: ID;
31
- name: string;
32
- open: DATE;
33
- close: DATE;
34
- override?: boolean;
35
- }
36
- export type AptlyProjectAlgorithm = AptlyProjectAlgorithmSchema<string>;
37
- export interface AptlyProjectAlgorithmSchema<ID> {
38
- _id: ID;
39
- name: string;
40
- pipeline: AptlyProjectAlgorithmPipelineSchema<ID>[];
41
- organization?: ID;
42
- project?: ID;
43
- }
44
- export type AptlyProjectAlgorithmPipeline = AptlyProjectAlgorithmPipelineSchema<string>;
45
- export interface AptlyProjectAlgorithmPipelineSchema<ID> {
46
- _id: ID;
47
- label: string;
48
- operation: 'base' | 'add' | 'subtract' | 'multiply';
49
- value: number;
50
- applyTo: 'previousStep' | 'base' | 'root';
51
- }
30
+ export type AptlyProjectPeriod = AptlyPeriod;
31
+ export type AptlyProjectPeriodSchema<ID, DATE> = AptlyPeriodSchema<ID, DATE>;
32
+ export type AptlyProjectAlgorithm = AptlyAlgorithm;
33
+ export type AptlyProjectAlgorithmSchema<ID> = AptlyAlgorithmSchema<ID>;
34
+ export type AptlyProjectAlgorithmPipeline = AptlyAlgorithmPipeline;
35
+ export type AptlyProjectAlgorithmPipelineSchema<ID> = AptlyAlgorithmPipelineSchema<ID>;
52
36
  export interface AptlyProjectTheme {
53
37
  palette?: {
54
38
  primary?: AptlyProjectThemePalette;
@@ -1,10 +1,11 @@
1
+ import { AptlyAlgorithmSchema } from './algorithm.js';
1
2
  import { AptlyBaseSchema, AptlyHistorySchema } from './extends.js';
2
3
  import { AptlyCategorySectionDisplayType, AptlyUnitTemplateCategorySectionProductMeasureUnitType, AptlyUnitTemplateCategorySectionProductParamKey } from '../enums/index.js';
4
+ import { AptlyPeriodSchema } from './period.js';
3
5
  import { AptlyProductSchema } from './product.js';
4
6
  import { AptlyProducerSchema } from './producer.js';
5
7
  import { AptlyMediaSrcSchema } from './media.js';
6
8
  import { AptlyUpsellTemplateSchema } from './upsell-template.js';
7
- import { AptlyProjectAlgorithmSchema, AptlyProjectPeriodSchema } from './project.js';
8
9
  export type AptlyUnitTemplateBase = AptlyUnitTemplateBaseSchema<string, string>;
9
10
  export interface AptlyUnitTemplateBaseSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
10
11
  _order_categories: ID[];
@@ -51,7 +52,7 @@ export interface AptlyUnitTemplateCategorySectionSchema<ID, DATE> {
51
52
  assortments?: AptlyUnitTemplateCategorySectionAssortmentSchema<ID, DATE>[];
52
53
  _order_products: ID[];
53
54
  products: AptlyUnitTemplateCategorySectionProductSchema<ID, DATE>[];
54
- period: AptlyProjectPeriodSchema<ID, DATE> | ID;
55
+ period: AptlyPeriodSchema<ID, DATE> | ID;
55
56
  }
56
57
  export type AptlyUnitTemplateCategorySectionPackage = AptlyUnitTemplateCategorySectionPackageSchema<string, string>;
57
58
  export interface AptlyUnitTemplateCategorySectionPackageSchema<ID, DATE> {
@@ -85,7 +86,7 @@ export interface AptlyUnitTemplateCategorySectionProductSchema<ID, DATE> {
85
86
  consequenceParam?: string;
86
87
  amount: number;
87
88
  unitCost?: number;
88
- algorithm: ID | AptlyProjectAlgorithmSchema<ID>;
89
+ algorithm: ID | AptlyAlgorithmSchema<ID>;
89
90
  standard: boolean;
90
91
  standardVariant?: ID;
91
92
  partOfPackage?: ID;
package/models/user.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ import { AptlyUserRole } from '../core/index.js';
1
2
  import { AptlyBaseSchema } from './extends.js';
2
3
  export type AptlyUser = AptlyUserSchema<string, string>;
3
4
  export interface AptlyUserSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'archived' | 'name'> {
@@ -6,7 +7,7 @@ export interface AptlyUserSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE
6
7
  firstName?: string;
7
8
  lastName?: string;
8
9
  profileImage: string | null;
9
- permissions: number | string | string[];
10
+ permissions: AptlyUserRole[];
10
11
  gdpr: boolean;
11
12
  phone: string;
12
13
  synced: DATE;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aptly-as/types",
3
- "version": "1.12.5",
3
+ "version": "1.15.0-beta.1",
4
4
  "description": "Aptly types and enums",
5
5
  "type": "module",
6
6
  "main": "./index.js",
@@ -1,105 +0,0 @@
1
- export type AptlyPermissionGlobalModels = 'superAdmin' | 'admin' | 'beta' | 'default';
2
- export declare enum AptlyPermissionGlobalModel {
3
- Admin = "admin",
4
- Beta = "beta",
5
- Default = "default",
6
- SuperAdmin = "superAdmin"
7
- }
8
- export type AptlyPermissionModules = 'projectBooking' | 'projectSupport' | 'projectRecommendations';
9
- export type AptlyPermissionModulesModels = 'default' | 'core' | 'algorithms' | 'departments' | 'booking' | 'unitExtraOptions' | 'unitExtraFields' | 'pages' | 'recommendations' | 'subcontractor' | 'optionLabels' | 'support' | 'productsExtended' | 'testing';
10
- export declare enum AptlyPermissionModulesModel {
11
- Algorithms = "algorithms",
12
- Booking = "booking",
13
- Core = "core",
14
- Default = "default",
15
- Departments = "departments",
16
- OptionLabels = "optionLabels",
17
- Pages = "pages",
18
- ProductsExtended = "productsExtended",
19
- Recommendations = "recommendations",
20
- Subcontractor = "subcontractor",
21
- Support = "support",
22
- Testing = "testing",
23
- UnitExtraOptions = "unitExtraOptions",
24
- UnitExtraFields = "unitExtraFields"
25
- }
26
- export type AptlyPermissionOrganizationModels = 'testingAdmin' | 'admin' | 'projectAdmin' | 'content' | 'organizationContent' | 'reports' | 'support' | 'thirdParty' | 'default';
27
- export declare enum AptlyPermissionOrganizationModel {
28
- Admin = "admin",
29
- Content = "content",
30
- OrganizationContent = "organizationContent",
31
- Default = "default",
32
- ProjectAdmin = "projectAdmin",
33
- TestingAdmin = "testingAdmin",
34
- Reports = "reports",
35
- Support = "support",
36
- ThirdParty = "thirdParty"
37
- }
38
- export type AptlyPermissionModels = 'admin' | 'adminBilling' | 'adminProducers' | 'adminProducts' | 'adminReport' | 'adminStats' | 'adminSuppliers' | 'adminTags' | 'adminTesting' | 'adminUsers' | 'adminOrganizations' | 'beta' | 'organization' | 'organizationAlgorithms' | 'organizationBooking' | 'organizationClients' | 'organizationDepartments' | 'organizationLogo' | 'organizationMembers' | 'organizationOptionLabels' | 'organizationOrders' | 'organizationPages' | 'organizationProducts' | 'organizationProductsExtended' | 'organizationRecommendations' | 'organizationReport' | 'organizationStats' | 'organizationUnitTemplates' | 'organizationUpsellTemplates' | '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' | 'unitNotes' | 'unitOrders' | 'unitPages' | 'unitProducts' | 'unitReport';
39
- export declare enum AptlyPermissionModel {
40
- Admin = "admin",
41
- AdminBilling = "adminBilling",
42
- AdminProducers = "adminProducers",
43
- AdminProducts = "adminProducts",
44
- AdminReport = "adminReport",
45
- AdminStats = "adminStats",
46
- AdminSuppliers = "adminSuppliers",
47
- AdminTags = "adminTags",
48
- AdminTesting = "adminTesting",
49
- AdminUsers = "adminUsers",
50
- AdminOrganizations = "adminOrganizations",
51
- Beta = "beta",
52
- Organization = "organization",
53
- OrganizationAlgorithms = "organizationAlgorithms",
54
- OrganizationBooking = "organizationBooking",
55
- OrganizationClients = "organizationClients",
56
- OrganizationDepartments = "organizationDepartments",
57
- OrganizationLogo = "organizationLogo",
58
- OrganizationMembers = "organizationMembers",
59
- OrganizationOptionLabels = "organizationOptionLabels",
60
- OrganizationOrders = "organizationOrders",
61
- OrganizationPages = "organizationPages",
62
- OrganizationProducts = "organizationProducts",
63
- OrganizationProductsExtended = "organizationProductsExtended",
64
- OrganizationRecommendations = "organizationRecommendations",
65
- OrganizationReport = "organizationReport",
66
- OrganizationStats = "organizationStats",
67
- OrganizationUnitTemplates = "organizationUnitTemplates",
68
- OrganizationUpsellTemplates = "organizationUpsellTemplates",
69
- OrganizationWebhooks = "organizationWebhooks",
70
- Project = "project",
71
- ProjectAlgorithms = "projectAlgorithms",
72
- ProjectBooking = "projectBooking",
73
- ProjectDocuments = "projectDocuments",
74
- ProjectInquiry = "projectInquiry",
75
- ProjectOrders = "projectOrders",
76
- ProjectPages = "projectPages",
77
- ProjectPeriods = "projectPeriods",
78
- ProjectProducts = "projectProducts",
79
- ProjectRecommendations = "projectRecommendations",
80
- ProjectReport = "projectReport",
81
- ProjectReportPrice = "projectReportPrice",
82
- ProjectTheme = "projectTheme",
83
- ProjectSigning = "projectSigning",
84
- ProjectSubcontractor = "projectSubcontractor",
85
- ProjectUnits = "projectUnits",
86
- ProjectUnitInvites = "projectUnitInvites",
87
- ProjectUnitExtraFields = "projectUnitExtraFields",
88
- ProjectUnitExtraOptions = "projectUnitExtraOptions",
89
- ProjectUnitTemplates = "projectUnitTemplates",
90
- ProjectUnitTemplatesAlgorithms = "projectUnitTemplatesAlgorithms",
91
- ProjectUnitTemplatesPrices = "projectUnitTemplatesPrices",
92
- ProjectUpsellTemplates = "projectUpsellTemplates",
93
- Unit = "unit",
94
- UnitBooking = "unitBooking",
95
- UnitInquiry = "unitInquiry",
96
- UnitNotes = "unitNotes",
97
- UnitOrders = "unitOrders",
98
- UnitPages = "unitPages",
99
- UnitProducts = "unitProducts",
100
- UnitReport = "unitReport"
101
- }
102
- export type AptlyPermissionCrud = 'C' | 'R' | 'U' | 'D';
103
- export type AptlyPermissionSchema = {
104
- [key in AptlyPermissionModels]: 'R' | 'CR' | 'CRU' | 'RU' | 'CRUD';
105
- };
@@ -1,100 +0,0 @@
1
- export var AptlyPermissionGlobalModel;
2
- (function (AptlyPermissionGlobalModel) {
3
- AptlyPermissionGlobalModel["Admin"] = "admin";
4
- AptlyPermissionGlobalModel["Beta"] = "beta";
5
- AptlyPermissionGlobalModel["Default"] = "default";
6
- AptlyPermissionGlobalModel["SuperAdmin"] = "superAdmin";
7
- })(AptlyPermissionGlobalModel || (AptlyPermissionGlobalModel = {}));
8
- export var AptlyPermissionModulesModel;
9
- (function (AptlyPermissionModulesModel) {
10
- AptlyPermissionModulesModel["Algorithms"] = "algorithms";
11
- AptlyPermissionModulesModel["Booking"] = "booking";
12
- AptlyPermissionModulesModel["Core"] = "core";
13
- AptlyPermissionModulesModel["Default"] = "default";
14
- AptlyPermissionModulesModel["Departments"] = "departments";
15
- AptlyPermissionModulesModel["OptionLabels"] = "optionLabels";
16
- AptlyPermissionModulesModel["Pages"] = "pages";
17
- AptlyPermissionModulesModel["ProductsExtended"] = "productsExtended";
18
- AptlyPermissionModulesModel["Recommendations"] = "recommendations";
19
- AptlyPermissionModulesModel["Subcontractor"] = "subcontractor";
20
- AptlyPermissionModulesModel["Support"] = "support";
21
- AptlyPermissionModulesModel["Testing"] = "testing";
22
- AptlyPermissionModulesModel["UnitExtraOptions"] = "unitExtraOptions";
23
- AptlyPermissionModulesModel["UnitExtraFields"] = "unitExtraFields";
24
- })(AptlyPermissionModulesModel || (AptlyPermissionModulesModel = {}));
25
- export var AptlyPermissionOrganizationModel;
26
- (function (AptlyPermissionOrganizationModel) {
27
- AptlyPermissionOrganizationModel["Admin"] = "admin";
28
- AptlyPermissionOrganizationModel["Content"] = "content";
29
- AptlyPermissionOrganizationModel["OrganizationContent"] = "organizationContent";
30
- AptlyPermissionOrganizationModel["Default"] = "default";
31
- AptlyPermissionOrganizationModel["ProjectAdmin"] = "projectAdmin";
32
- AptlyPermissionOrganizationModel["TestingAdmin"] = "testingAdmin";
33
- AptlyPermissionOrganizationModel["Reports"] = "reports";
34
- AptlyPermissionOrganizationModel["Support"] = "support";
35
- AptlyPermissionOrganizationModel["ThirdParty"] = "thirdParty";
36
- })(AptlyPermissionOrganizationModel || (AptlyPermissionOrganizationModel = {}));
37
- export var AptlyPermissionModel;
38
- (function (AptlyPermissionModel) {
39
- AptlyPermissionModel["Admin"] = "admin";
40
- AptlyPermissionModel["AdminBilling"] = "adminBilling";
41
- AptlyPermissionModel["AdminProducers"] = "adminProducers";
42
- AptlyPermissionModel["AdminProducts"] = "adminProducts";
43
- AptlyPermissionModel["AdminReport"] = "adminReport";
44
- AptlyPermissionModel["AdminStats"] = "adminStats";
45
- AptlyPermissionModel["AdminSuppliers"] = "adminSuppliers";
46
- AptlyPermissionModel["AdminTags"] = "adminTags";
47
- AptlyPermissionModel["AdminTesting"] = "adminTesting";
48
- AptlyPermissionModel["AdminUsers"] = "adminUsers";
49
- AptlyPermissionModel["AdminOrganizations"] = "adminOrganizations";
50
- AptlyPermissionModel["Beta"] = "beta";
51
- AptlyPermissionModel["Organization"] = "organization";
52
- AptlyPermissionModel["OrganizationAlgorithms"] = "organizationAlgorithms";
53
- AptlyPermissionModel["OrganizationBooking"] = "organizationBooking";
54
- AptlyPermissionModel["OrganizationClients"] = "organizationClients";
55
- AptlyPermissionModel["OrganizationDepartments"] = "organizationDepartments";
56
- AptlyPermissionModel["OrganizationLogo"] = "organizationLogo";
57
- AptlyPermissionModel["OrganizationMembers"] = "organizationMembers";
58
- AptlyPermissionModel["OrganizationOptionLabels"] = "organizationOptionLabels";
59
- AptlyPermissionModel["OrganizationOrders"] = "organizationOrders";
60
- AptlyPermissionModel["OrganizationPages"] = "organizationPages";
61
- AptlyPermissionModel["OrganizationProducts"] = "organizationProducts";
62
- AptlyPermissionModel["OrganizationProductsExtended"] = "organizationProductsExtended";
63
- AptlyPermissionModel["OrganizationRecommendations"] = "organizationRecommendations";
64
- AptlyPermissionModel["OrganizationReport"] = "organizationReport";
65
- AptlyPermissionModel["OrganizationStats"] = "organizationStats";
66
- AptlyPermissionModel["OrganizationUnitTemplates"] = "organizationUnitTemplates";
67
- AptlyPermissionModel["OrganizationUpsellTemplates"] = "organizationUpsellTemplates";
68
- AptlyPermissionModel["OrganizationWebhooks"] = "organizationWebhooks";
69
- AptlyPermissionModel["Project"] = "project";
70
- AptlyPermissionModel["ProjectAlgorithms"] = "projectAlgorithms";
71
- AptlyPermissionModel["ProjectBooking"] = "projectBooking";
72
- AptlyPermissionModel["ProjectDocuments"] = "projectDocuments";
73
- AptlyPermissionModel["ProjectInquiry"] = "projectInquiry";
74
- AptlyPermissionModel["ProjectOrders"] = "projectOrders";
75
- AptlyPermissionModel["ProjectPages"] = "projectPages";
76
- AptlyPermissionModel["ProjectPeriods"] = "projectPeriods";
77
- AptlyPermissionModel["ProjectProducts"] = "projectProducts";
78
- AptlyPermissionModel["ProjectRecommendations"] = "projectRecommendations";
79
- AptlyPermissionModel["ProjectReport"] = "projectReport";
80
- AptlyPermissionModel["ProjectReportPrice"] = "projectReportPrice";
81
- AptlyPermissionModel["ProjectTheme"] = "projectTheme";
82
- AptlyPermissionModel["ProjectSigning"] = "projectSigning";
83
- AptlyPermissionModel["ProjectSubcontractor"] = "projectSubcontractor";
84
- AptlyPermissionModel["ProjectUnits"] = "projectUnits";
85
- AptlyPermissionModel["ProjectUnitInvites"] = "projectUnitInvites";
86
- AptlyPermissionModel["ProjectUnitExtraFields"] = "projectUnitExtraFields";
87
- AptlyPermissionModel["ProjectUnitExtraOptions"] = "projectUnitExtraOptions";
88
- AptlyPermissionModel["ProjectUnitTemplates"] = "projectUnitTemplates";
89
- AptlyPermissionModel["ProjectUnitTemplatesAlgorithms"] = "projectUnitTemplatesAlgorithms";
90
- AptlyPermissionModel["ProjectUnitTemplatesPrices"] = "projectUnitTemplatesPrices";
91
- AptlyPermissionModel["ProjectUpsellTemplates"] = "projectUpsellTemplates";
92
- AptlyPermissionModel["Unit"] = "unit";
93
- AptlyPermissionModel["UnitBooking"] = "unitBooking";
94
- AptlyPermissionModel["UnitInquiry"] = "unitInquiry";
95
- AptlyPermissionModel["UnitNotes"] = "unitNotes";
96
- AptlyPermissionModel["UnitOrders"] = "unitOrders";
97
- AptlyPermissionModel["UnitPages"] = "unitPages";
98
- AptlyPermissionModel["UnitProducts"] = "unitProducts";
99
- AptlyPermissionModel["UnitReport"] = "unitReport";
100
- })(AptlyPermissionModel || (AptlyPermissionModel = {}));