@aptly-as/types 1.8.0 → 1.9.0

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.
Files changed (91) hide show
  1. package/core/api.js +1 -2
  2. package/core/app.d.ts +2 -2
  3. package/core/app.js +2 -5
  4. package/core/cloudinary.d.ts +1 -1
  5. package/core/cloudinary.js +1 -2
  6. package/core/error.d.ts +1 -1
  7. package/core/error.js +1 -2
  8. package/core/fields.d.ts +1 -1
  9. package/core/fields.js +1 -2
  10. package/core/index.d.ts +10 -10
  11. package/core/index.js +9 -21
  12. package/core/permission.d.ts +8 -22
  13. package/core/permission.js +9 -11
  14. package/core/scope.d.ts +3 -3
  15. package/core/scope.js +2 -5
  16. package/core/signage.d.ts +3 -3
  17. package/core/signage.js +1 -2
  18. package/core/webhook-event-data.d.ts +1 -1
  19. package/core/webhook-event-data.js +1 -2
  20. package/enums/document.js +4 -7
  21. package/enums/fields.js +2 -5
  22. package/enums/index.d.ts +4 -4
  23. package/enums/index.js +36 -49
  24. package/enums/unit-template.js +4 -7
  25. package/enums/webhook.js +6 -9
  26. package/index.d.ts +3 -3
  27. package/index.js +3 -15
  28. package/models/algorithm.d.ts +2 -2
  29. package/models/algorithm.js +4 -7
  30. package/models/app.d.ts +8 -8
  31. package/models/app.js +6 -9
  32. package/models/availability.js +1 -2
  33. package/models/booking.d.ts +7 -6
  34. package/models/booking.js +1 -2
  35. package/models/client.d.ts +3 -6
  36. package/models/client.js +1 -2
  37. package/models/department.d.ts +11 -11
  38. package/models/department.js +1 -2
  39. package/models/document.d.ts +4 -10
  40. package/models/document.js +1 -2
  41. package/models/extends.d.ts +4 -10
  42. package/models/extends.js +1 -2
  43. package/models/index.d.ts +30 -29
  44. package/models/index.js +30 -41
  45. package/models/inquiry.d.ts +9 -12
  46. package/models/inquiry.js +1 -2
  47. package/models/media.d.ts +5 -14
  48. package/models/media.js +1 -2
  49. package/models/note.d.ts +18 -0
  50. package/models/note.js +1 -0
  51. package/models/notification-trigger.d.ts +1 -1
  52. package/models/notification-trigger.js +1 -2
  53. package/models/option-label.d.ts +2 -5
  54. package/models/option-label.js +1 -2
  55. package/models/order.d.ts +8 -11
  56. package/models/order.js +1 -2
  57. package/models/organization.d.ts +13 -16
  58. package/models/organization.js +1 -2
  59. package/models/page.d.ts +4 -13
  60. package/models/page.js +1 -2
  61. package/models/producer.d.ts +3 -9
  62. package/models/producer.js +1 -2
  63. package/models/product-stats.d.ts +2 -2
  64. package/models/product-stats.js +1 -2
  65. package/models/product.d.ts +7 -13
  66. package/models/product.js +1 -2
  67. package/models/project.d.ts +14 -31
  68. package/models/project.js +1 -2
  69. package/models/queue-download.d.ts +5 -5
  70. package/models/queue-download.js +1 -2
  71. package/models/recommendation.d.ts +3 -3
  72. package/models/recommendation.js +1 -2
  73. package/models/supplier.d.ts +3 -6
  74. package/models/supplier.js +1 -2
  75. package/models/tag.d.ts +2 -5
  76. package/models/tag.js +1 -2
  77. package/models/unit-email.d.ts +7 -10
  78. package/models/unit-email.js +2 -5
  79. package/models/unit-template.d.ts +17 -26
  80. package/models/unit-template.js +1 -2
  81. package/models/unit.d.ts +20 -34
  82. package/models/unit.js +1 -2
  83. package/models/upsell-template.d.ts +2 -8
  84. package/models/upsell-template.js +1 -2
  85. package/models/user.d.ts +2 -5
  86. package/models/user.js +1 -2
  87. package/models/webhook-event.d.ts +5 -8
  88. package/models/webhook-event.js +1 -2
  89. package/models/webhook.d.ts +3 -6
  90. package/models/webhook.js +1 -2
  91. package/package.json +7 -8
package/models/unit.d.ts CHANGED
@@ -1,12 +1,12 @@
1
1
  import { AptlyProducerSchema } from './producer.js';
2
2
  import { AptlyProductSchema } from './product.js';
3
- import { AptlyProjectSchema } from './project';
4
- import { AptlyHistorySchema } from './extends';
3
+ import { AptlyProjectSchema } from './project.js';
4
+ import { AptlyHistorySchema } from './extends.js';
5
5
  import { AptlyUnitTemplateBaseSchema, AptlyUnitTemplateCategorySchema, AptlyUnitTemplateCategorySectionSchema, AptlyUnitTemplateSchema } from './unit-template';
6
- import { AptlyIntegration, AptlyUnitItemParamKey, AptlyUnitStatus } from '../enums';
7
- import { AptlyUserSchema } from './user';
8
- import { AptlyOrganizationSchema } from './organization';
9
- export declare type AptlyUnit = AptlyUnitSchema<string, string>;
6
+ import { AptlyIntegration, AptlyUnitItemParamKey, AptlyUnitStatus } from '../enums/index.js';
7
+ import { AptlyUserSchema } from './user.js';
8
+ import { AptlyOrganizationSchema } from './organization.js';
9
+ export type AptlyUnit = AptlyUnitSchema<string, string>;
10
10
  export interface AptlyUnitSchema<ID, DATE> extends AptlyUnitTemplateBaseSchema<ID, DATE>, AptlyUnitEditData<DATE>, AptlyHistorySchema<ID, DATE> {
11
11
  status: AptlyUnitStatus;
12
12
  rooms: AptlyUnitRoomSchema<ID>[];
@@ -33,25 +33,19 @@ export interface AptlyUnitSchema<ID, DATE> extends AptlyUnitTemplateBaseSchema<I
33
33
  confirmedPeriods: AptlyUnitConfirmedPeriodSchema<ID>[];
34
34
  queueInvites: string[];
35
35
  invites: AptlyUnitInviteSchema<ID, DATE>[];
36
- /**
37
- * @deprecated use overridePeriods
38
- */
39
36
  overridePeriod?: ID;
40
37
  overridePeriods?: AptlyUnitOverridePeriodSchema<ID, DATE>[];
41
38
  integrations: AptlyUnitIntegrationSchema<ID>[];
42
39
  tree: any[];
43
- /**
44
- * @deprecated use createdAt
45
- */
46
40
  created: DATE;
47
41
  }
48
- export declare type AptlyUnitOverridePeriod = AptlyUnitOverridePeriodSchema<string, string>;
42
+ export type AptlyUnitOverridePeriod = AptlyUnitOverridePeriodSchema<string, string>;
49
43
  export interface AptlyUnitOverridePeriodSchema<ID, DATE> {
50
44
  _id: ID;
51
45
  period: ID;
52
46
  close: DATE;
53
47
  }
54
- export declare type AptlyUnitItemBase = AptlyUnitItemBaseSchema<string, string>;
48
+ export type AptlyUnitItemBase = AptlyUnitItemBaseSchema<string, string>;
55
49
  export interface AptlyUnitItemBaseSchema<ID, DATE> {
56
50
  _id: ID;
57
51
  product: ID | AptlyProductSchema<ID, DATE>;
@@ -69,7 +63,7 @@ export interface AptlyUnitItemBaseSchema<ID, DATE> {
69
63
  params: AptlyUnitItemParamSchema<ID>[];
70
64
  baseCost?: number;
71
65
  }
72
- export declare type AptlyUnitOption = AptlyUnitSelectedOptionSchema<string, string>;
66
+ export type AptlyUnitOption = AptlyUnitSelectedOptionSchema<string, string>;
73
67
  export interface AptlyUnitSelectedOptionSchema<ID, DATE> {
74
68
  _id: ID;
75
69
  category: ID | AptlyUnitTemplateCategorySchema<ID, DATE>;
@@ -86,15 +80,15 @@ export interface AptlyUnitSelectedOptionSchema<ID, DATE> {
86
80
  package?: ID;
87
81
  standard?: boolean;
88
82
  text?: string;
89
- producer?: ID;
83
+ producer?: ID | AptlyProducerSchema<ID, DATE>;
90
84
  baseCost?: number;
91
85
  }
92
- export declare type AptlyUnitOptionItem = AptlyUnitOptionItemSchema<string, string>;
86
+ export type AptlyUnitOptionItem = AptlyUnitOptionItemSchema<string, string>;
93
87
  export interface AptlyUnitOptionItemSchema<ID, DATE> extends AptlyUnitSelectedOptionSchema<ID, DATE> {
94
88
  unitCost: number;
95
89
  pickRef?: ID;
96
90
  }
97
- export declare type AptlyUnitOptionExtraItem = AptlyUnitOptionExtraItemSchema<string, string>;
91
+ export type AptlyUnitOptionExtraItem = AptlyUnitOptionExtraItemSchema<string, string>;
98
92
  export interface AptlyUnitOptionExtraItemSchema<ID, DATE> extends AptlyUnitOptionItemSchema<ID, DATE> {
99
93
  _id: ID;
100
94
  unitCost: number;
@@ -105,48 +99,40 @@ export interface AptlyUnitOptionExtraItemSchema<ID, DATE> extends AptlyUnitOptio
105
99
  projectItemRef?: ID;
106
100
  revertedOption?: boolean;
107
101
  revertItemRef?: ID;
108
- /** @deprecated. Not sure this is used */
109
102
  document?: ID;
110
- /** @deprecated. Not sure this is used */
111
103
  prerequisites?: {
112
104
  totalCost?: number;
113
105
  };
114
- /** @deprecated. Not sure this is used */
115
106
  thirdPartyUploader?: string;
116
- /** @deprecated. Not sure this is used */
117
107
  cost: number;
118
- /** @deprecated. Cant se this is used anymore */
119
108
  customTitle?: string;
120
109
  }
121
- export declare type AptlyUnitItemParam<VALUE> = AptlyUnitItemParamSchema<string, VALUE>;
110
+ export type AptlyUnitItemParam<VALUE> = AptlyUnitItemParamSchema<string, VALUE>;
122
111
  export interface AptlyUnitItemParamSchema<ID, VALUE = any> {
123
112
  _id: ID;
124
113
  key: AptlyUnitItemParamKey;
125
114
  value: VALUE;
126
115
  downloadToken?: string;
127
116
  }
128
- export declare type AptlyUnitRoom = AptlyUnitRoomSchema<string>;
117
+ export type AptlyUnitRoom = AptlyUnitRoomSchema<string>;
129
118
  export interface AptlyUnitRoomSchema<ID> {
130
119
  _id: ID;
131
120
  name: string;
132
121
  sizeParams: AptlyUnitRoomSchemaSizeParamSchema<ID>[];
133
122
  }
134
- export declare type AptlyUnitRoomSchemaSizeParam = AptlyUnitRoomSchemaSizeParamSchema<string>;
123
+ export type AptlyUnitRoomSchemaSizeParam = AptlyUnitRoomSchemaSizeParamSchema<string>;
135
124
  export interface AptlyUnitRoomSchemaSizeParamSchema<ID> {
136
125
  _id: ID;
137
126
  key: string;
138
127
  value: number;
139
128
  }
140
- export declare type AptlyUnitCategoryOverride = AptlyUnitCategoryOverrideSchema<string>;
129
+ export type AptlyUnitCategoryOverride = AptlyUnitCategoryOverrideSchema<string>;
141
130
  export interface AptlyUnitCategoryOverrideSchema<ID> {
142
131
  category: ID;
143
- /**
144
- * @deprecated Not used i think
145
- */
146
132
  size: number;
147
133
  hide: boolean;
148
134
  }
149
- export declare type AptlyUnitProductOverride = AptlyUnitProductOverrideSchema<string>;
135
+ export type AptlyUnitProductOverride = AptlyUnitProductOverrideSchema<string>;
150
136
  export interface AptlyUnitProductOverrideSchema<ID> {
151
137
  sectionProductRef: ID;
152
138
  section: ID;
@@ -156,7 +142,7 @@ export interface AptlyUnitProductOverrideSchema<ID> {
156
142
  variantPrices?: AptlyUnitProductOverrideVariantPriceSchema<ID>[];
157
143
  hide?: boolean;
158
144
  }
159
- export declare type AptlyUnitProductOverrideVariantPrice = AptlyUnitProductOverrideVariantPriceSchema<string>;
145
+ export type AptlyUnitProductOverrideVariantPrice = AptlyUnitProductOverrideVariantPriceSchema<string>;
160
146
  export interface AptlyUnitProductOverrideVariantPriceSchema<ID> {
161
147
  _id: ID;
162
148
  variant: ID;
@@ -174,13 +160,13 @@ export interface AptlyUnitSpec {
174
160
  }[];
175
161
  }[];
176
162
  }
177
- export declare type AptlyUnitConfirmedPeriod = AptlyUnitConfirmedPeriodSchema<string>;
163
+ export type AptlyUnitConfirmedPeriod = AptlyUnitConfirmedPeriodSchema<string>;
178
164
  export interface AptlyUnitConfirmedPeriodSchema<ID> {
179
165
  _id: ID;
180
166
  period: ID;
181
167
  order: ID;
182
168
  }
183
- export declare type AptlyUnitIntegration = AptlyUnitIntegrationSchema<string>;
169
+ export type AptlyUnitIntegration = AptlyUnitIntegrationSchema<string>;
184
170
  export interface AptlyUnitIntegrationSchema<ID> {
185
171
  _id: ID;
186
172
  integration: AptlyIntegration;
package/models/unit.js CHANGED
@@ -1,2 +1 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ export {};
@@ -1,5 +1,5 @@
1
- import { AptlyBaseSchema, AptlyHistorySchema } from './extends';
2
- export declare type AptlyUpsellTemplate = AptlyUpsellTemplateSchema<string, string>;
1
+ import { AptlyBaseSchema, AptlyHistorySchema } from './extends.js';
2
+ export type AptlyUpsellTemplate = AptlyUpsellTemplateSchema<string, string>;
3
3
  export interface AptlyUpsellTemplateSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE>, AptlyHistorySchema<ID, DATE> {
4
4
  image?: string | null;
5
5
  imageMedia?: string | null;
@@ -8,12 +8,6 @@ export interface AptlyUpsellTemplateSchema<ID, DATE> extends AptlyBaseSchema<ID,
8
8
  links: ID[];
9
9
  organization?: ID;
10
10
  project?: ID;
11
- /**
12
- * @deprecated use createdAt
13
- */
14
11
  created: DATE;
15
- /**
16
- * @deprecated not used.. Only for frontend
17
- */
18
12
  description: string;
19
13
  }
@@ -1,2 +1 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ export {};
package/models/user.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { AptlyBaseSchema } from './extends';
2
- export declare type AptlyUser = AptlyUserSchema<string, string>;
1
+ import { AptlyBaseSchema } from './extends.js';
2
+ export type AptlyUser = AptlyUserSchema<string, string>;
3
3
  export interface AptlyUserSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'archived' | 'name'> {
4
4
  email: string;
5
5
  fullName: string;
@@ -10,8 +10,5 @@ export interface AptlyUserSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE
10
10
  gdpr: boolean;
11
11
  phone: string;
12
12
  synced: DATE;
13
- /**
14
- * @deprecated use createdAt
15
- */
16
13
  created: DATE;
17
14
  }
package/models/user.js CHANGED
@@ -1,2 +1 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ export {};
@@ -1,7 +1,7 @@
1
- import { AptlyWebhookEventStatus, AptlyWebhookType } from '../enums';
2
- import { AptlyBaseSchema } from './extends';
3
- declare type ServerKeys = 'run' | 'organization' | 'project' | 'status' | 'url' | 'headers' | 'responses';
4
- export declare type AptlyWebhookEvent<T = unknown> = Omit<AptlyWebhookEventSchema<string, string, T>, ServerKeys>;
1
+ import { AptlyWebhookEventStatus, AptlyWebhookType } from '../enums/index.js';
2
+ import { AptlyBaseSchema } from './extends.js';
3
+ type ServerKeys = 'run' | 'organization' | 'project' | 'status' | 'url' | 'headers' | 'responses';
4
+ export type AptlyWebhookEvent<T = unknown> = Omit<AptlyWebhookEventSchema<string, string, T>, ServerKeys>;
5
5
  export interface AptlyWebhookEventSchema<ID, DATE, DATA = unknown> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
6
6
  specversion: string;
7
7
  type: AptlyWebhookType;
@@ -22,12 +22,9 @@ export interface AptlyWebhookEventSchema<ID, DATE, DATA = unknown> extends Omit<
22
22
  url: string;
23
23
  headers: AptlyWebhookEventHeaders;
24
24
  responses: AptlyWebhookEventResponseSchema<ID, DATE>[];
25
- /**
26
- * @deprecated use createdAt
27
- */
28
25
  created: DATE;
29
26
  }
30
- export declare type AptlyWebhookEventResponse<DATA = any> = AptlyWebhookEventResponseSchema<string, string, DATA>;
27
+ export type AptlyWebhookEventResponse<DATA = any> = AptlyWebhookEventResponseSchema<string, string, DATA>;
31
28
  export interface AptlyWebhookEventResponseSchema<ID, DATE, DATA = any> {
32
29
  _id: ID;
33
30
  time: DATE;
@@ -1,2 +1 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ export {};
@@ -1,5 +1,5 @@
1
- import { AptlyWebhookStatus, AptlyWebhookType } from '../enums';
2
- import { AptlyBaseSchema } from './extends';
1
+ import { AptlyWebhookStatus, AptlyWebhookType } from '../enums/index.js';
2
+ import { AptlyBaseSchema } from './extends.js';
3
3
  export interface AptlyWebhookSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
4
4
  organization: ID;
5
5
  user?: ID;
@@ -10,9 +10,6 @@ export interface AptlyWebhookSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE>
10
10
  types: AptlyWebhookType[];
11
11
  secret?: string;
12
12
  state?: string;
13
- /**
14
- * @deprecated use createdAt
15
- */
16
13
  created: DATE;
17
14
  }
18
- export declare type AptlyWebhook = AptlyWebhookSchema<string, string>;
15
+ export type AptlyWebhook = AptlyWebhookSchema<string, string>;
package/models/webhook.js CHANGED
@@ -1,2 +1 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ export {};
package/package.json CHANGED
@@ -1,15 +1,14 @@
1
1
  {
2
2
  "name": "@aptly-as/types",
3
- "version": "1.8.0",
3
+ "version": "1.9.0",
4
4
  "description": "Aptly types and enums",
5
+ "type": "module",
5
6
  "main": "./index.js",
6
7
  "types": "./index.d.ts",
7
8
  "module": "./index.js",
8
9
  "author": "Emil A. Olsen <emil@aptly.as>",
9
- "engines": {
10
- "node": ">14.0.0"
11
- },
12
10
  "scripts": {
11
+ "dev": "yarn start",
13
12
  "start": "yarn build:watch",
14
13
  "build": "tsc",
15
14
  "build:watch": "tsc --watch --incremental",
@@ -19,10 +18,10 @@
19
18
  "dependencies": {},
20
19
  "devDependencies": {
21
20
  "cloudinary": "^1.32.0",
22
- "husky": "^7.0.4",
23
- "lint-staged": "^12.3.4",
24
- "prettier": "^2.5.1",
25
- "typescript": "^4.2.4"
21
+ "husky": "^8.0.2",
22
+ "lint-staged": "^13.0.4",
23
+ "prettier": "^2.8.0",
24
+ "typescript": "^4.9.3"
26
25
  },
27
26
  "repository": {
28
27
  "type": "git",