@turndown/library 0.0.50 → 0.0.52

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 (6) hide show
  1. package/dist/types/base/index.d.ts +1 -0
  2. package/dist/types/inventory/index.d.ts +161 -2
  3. package/dist/types/inventory/index.js +14 -1
  4. package/dist/types/property/index.d.ts +40 -1
  5. package/dist/types/property/index.js +24 -0
  6. package/package.json +1 -1
package/dist/types/base/index.d.ts CHANGED
@@ -2,6 +2,7 @@ export type GenericTurndownObject = Record<string, any> | any | undefined;
2
2
  export type TurndownObject<T = GenericTurndownObject> = Record<string, T> | T | undefined;
3
3
  export type ObjectValues<T> = T[keyof T];
4
4
  export type ObjectKeys<T> = [keyof T];
5
+ export type Mode = "CREATE" | "EDIT" | "DELETE" | "DETAILS" | null;
5
6
  export declare const IMAGE_ENTITY: {
6
7
  USER_PROFILE: string;
7
8
  PROPERTY: string;
package/dist/types/inventory/index.d.ts CHANGED
@@ -1,15 +1,38 @@
1
- export type InventoryUnit = "COUNT" | "ROLLS" | "PODS" | "BOXES" | "BOTTLES" | "PACKS" | "BAGS" | "OTHER";
1
+ import { ObjectValues } from "../base";
2
+ export declare const INVENTORY_UNITS: {
3
+ COUNT: string;
4
+ ROLLS: string;
5
+ PODS: string;
6
+ BOXES: string;
7
+ BOTTLES: string;
8
+ PACKS: string;
9
+ BAGS: string;
10
+ OTHER: string;
11
+ };
12
+ export type InventoryUnitType = ObjectValues<typeof INVENTORY_UNITS>;
13
+ export declare const INVENTORY_ITEM_TYPE: {
14
+ readonly CONSUMABLE: "CONSUMABLE";
15
+ readonly FIXED: "FIXED";
16
+ };
17
+ export type InventoryItemType = ObjectValues<typeof INVENTORY_ITEM_TYPE>;
2
18
  export interface InventoryItem {
3
19
  id: string;
4
20
  companyId: string;
5
21
  name: string;
6
22
  description?: string;
7
- unit: InventoryUnit;
23
+ itemType: InventoryItemType;
24
+ unit: InventoryUnitType;
8
25
  unitCustom?: string;
9
26
  minimumLevel: number;
10
27
  reorderLevel: number;
11
28
  maximumLevel?: number;
12
29
  costPerUnit?: number;
30
+ supplierInfo?: string;
31
+ sku?: string;
32
+ barcode?: string;
33
+ deletedAt?: Date;
34
+ createdAt: Date;
35
+ updatedAt: Date;
13
36
  }
14
37
  export interface RoomInventory {
15
38
  id: string;
@@ -18,9 +41,114 @@ export interface RoomInventory {
18
41
  currentLevel: number;
19
42
  minimumLevel: number;
20
43
  maximumLevel?: number;
44
+ parLevel?: number;
45
+ lastRestockedAt?: Date;
46
+ lastRestockedBy?: string;
21
47
  lastCheckedAt?: Date;
22
48
  lastCheckedBy?: string;
23
49
  autoReorder: boolean;
50
+ locationNotes?: string;
51
+ deletedAt?: Date;
52
+ createdAt: Date;
53
+ updatedAt: Date;
54
+ }
55
+ export interface PropertyInventory {
56
+ id: string;
57
+ propertyId: string;
58
+ inventoryItemId: string;
59
+ currentLevel: number;
60
+ minimumLevel: number;
61
+ maximumLevel?: number;
62
+ parLevel?: number;
63
+ lastRestockedAt?: Date;
64
+ lastRestockedBy?: string;
65
+ lastCheckedAt?: Date;
66
+ lastCheckedBy?: string;
67
+ autoReorder: boolean;
68
+ locationNotes?: string;
69
+ deletedAt?: Date;
70
+ createdAt: Date;
71
+ updatedAt: Date;
72
+ }
73
+ export interface InventoryCount {
74
+ id: string;
75
+ checklistExecutionId: string;
76
+ roomInventoryId: string;
77
+ previousLevel: number;
78
+ countedLevel: number;
79
+ consumedAmount: number;
80
+ restockedAmount: number;
81
+ finalLevel: number;
82
+ countedBy: string;
83
+ countedAt: Date;
84
+ needsRestock: boolean;
85
+ notes?: string;
86
+ createdAt: Date;
87
+ }
88
+ export interface InventoryRestockOrder {
89
+ id: string;
90
+ companyId: string;
91
+ orderNumber?: string;
92
+ status: "PENDING" | "ORDERED" | "SHIPPED" | "RECEIVED";
93
+ totalItems?: number;
94
+ totalCost?: number;
95
+ orderedBy?: string;
96
+ orderedAt?: Date;
97
+ expectedDelivery?: Date;
98
+ receivedBy?: string;
99
+ receivedAt?: Date;
100
+ supplierInfo?: string;
101
+ notes?: string;
102
+ createdAt: Date;
103
+ updatedAt: Date;
104
+ }
105
+ export interface InventoryRestockOrderItem {
106
+ id: string;
107
+ orderId: string;
108
+ inventoryItemId: string;
109
+ roomInventoryId?: string;
110
+ propertyInventoryId?: string;
111
+ quantityOrdered: number;
112
+ quantityReceived: number;
113
+ unitCost?: number;
114
+ totalCost?: number;
115
+ createdAt: Date;
116
+ }
117
+ export interface RoomInventory {
118
+ id: string;
119
+ roomId: string;
120
+ inventoryItemId: string;
121
+ currentLevel: number;
122
+ minimumLevel: number;
123
+ maximumLevel?: number;
124
+ parLevel?: number;
125
+ lastRestockedAt?: Date;
126
+ lastRestockedBy?: string;
127
+ lastCheckedAt?: Date;
128
+ lastCheckedBy?: string;
129
+ autoReorder: boolean;
130
+ locationNotes?: string;
131
+ deletedAt?: Date;
132
+ createdAt: Date;
133
+ updatedAt: Date;
134
+ }
135
+ export interface PropertyInventory {
136
+ id: string;
137
+ propertyId: string;
138
+ inventoryItemId: string;
139
+ currentLevel: number;
140
+ minimumLevel: number;
141
+ maximumLevel?: number;
142
+ parLevel?: number;
143
+ lastRestockedAt?: Date;
144
+ lastRestockedBy?: string;
145
+ lastCheckedAt?: Date;
146
+ lastCheckedBy?: string;
147
+ autoReorder: boolean;
148
+ locationNotes?: string;
149
+ deletedAt?: Date;
150
+ createdAt: Date;
151
+ updatedAt: Date;
24
152
  }
25
153
  export interface InventoryCount {
26
154
  id: string;
@@ -30,8 +158,39 @@ export interface InventoryCount {
30
158
  countedLevel: number;
31
159
  consumedAmount: number;
32
160
  restockedAmount: number;
161
+ finalLevel: number;
33
162
  countedBy: string;
34
163
  countedAt: Date;
35
164
  needsRestock: boolean;
36
165
  notes?: string;
166
+ createdAt: Date;
167
+ }
168
+ export interface InventoryRestockOrder {
169
+ id: string;
170
+ companyId: string;
171
+ orderNumber?: string;
172
+ status: "PENDING" | "ORDERED" | "SHIPPED" | "RECEIVED";
173
+ totalItems?: number;
174
+ totalCost?: number;
175
+ orderedBy?: string;
176
+ orderedAt?: Date;
177
+ expectedDelivery?: Date;
178
+ receivedBy?: string;
179
+ receivedAt?: Date;
180
+ supplierInfo?: string;
181
+ notes?: string;
182
+ createdAt: Date;
183
+ updatedAt: Date;
184
+ }
185
+ export interface InventoryRestockOrderItem {
186
+ id: string;
187
+ orderId: string;
188
+ inventoryItemId: string;
189
+ roomInventoryId?: string;
190
+ propertyInventoryId?: string;
191
+ quantityOrdered: number;
192
+ quantityReceived: number;
193
+ unitCost?: number;
194
+ totalCost?: number;
195
+ createdAt: Date;
37
196
  }
package/dist/types/inventory/index.js CHANGED
@@ -1 +1,14 @@
1
- export {};
1
+ export const INVENTORY_UNITS = {
2
+ COUNT: "COUNT",
3
+ ROLLS: "ROLLS",
4
+ PODS: "PODS",
5
+ BOXES: "BOXES",
6
+ BOTTLES: "BOTTLES",
7
+ PACKS: "PACKS",
8
+ BAGS: "BAGS",
9
+ OTHER: "OTHER",
10
+ };
11
+ export const INVENTORY_ITEM_TYPE = {
12
+ CONSUMABLE: "CONSUMABLE",
13
+ FIXED: "FIXED",
14
+ };
package/dist/types/property/index.d.ts CHANGED
@@ -1,4 +1,29 @@
1
- import { USStateCodeType } from "../base";
1
+ import { ObjectValues, USStateCodeType } from "../base";
2
+ declare const PROPERTY_TYPES: {
3
+ HOUSE: string;
4
+ APARTMENT: string;
5
+ CONDO: string;
6
+ TOWNHOUSE: string;
7
+ VILLA: string;
8
+ CABIN: string;
9
+ COTTAGE: string;
10
+ BUNGALOW: string;
11
+ FARMHOUSE: string;
12
+ RANCH: string;
13
+ LOFT: string;
14
+ STUDIO: string;
15
+ DUPLEX: string;
16
+ TRIPLEX: string;
17
+ PENTHOUSE: string;
18
+ CHALET: string;
19
+ CASTLE: string;
20
+ BEACH_HOUSE: string;
21
+ HOUSEBOAT: string;
22
+ YURT: string;
23
+ TREEHOUSE: string;
24
+ OTHER: string;
25
+ };
26
+ export type PropertyType = ObjectValues<typeof PROPERTY_TYPES>;
2
27
  export interface Property {
3
28
  id: string;
4
29
  displayName: string;
@@ -6,12 +31,26 @@ export interface Property {
6
31
  addressLine2?: string;
7
32
  city?: string;
8
33
  stateCode?: USStateCodeType;
34
+ propertyType?: PropertyType;
35
+ sqft?: number;
9
36
  postalCode?: string;
10
37
  country?: string;
11
38
  timezone?: string;
12
39
  photoUrl?: string;
13
40
  companyId: string;
41
+ specialNotes?: string;
14
42
  deletedAt?: Date;
15
43
  createdAt: Date;
16
44
  updatedAt: Date;
17
45
  }
46
+ export interface PropertyAccessInformation {
47
+ propertyId: string;
48
+ entryInstructions?: string;
49
+ accessCode?: string;
50
+ wifiName?: string;
51
+ wifiPassword?: string;
52
+ alarmCode?: string;
53
+ parkingInfo?: string;
54
+ specialNotes?: string;
55
+ }
56
+ export {};
package/dist/types/property/index.js CHANGED
@@ -1 +1,25 @@
1
+ const PROPERTY_TYPES = {
2
+ HOUSE: "House",
3
+ APARTMENT: "Apartment",
4
+ CONDO: "Condo",
5
+ TOWNHOUSE: "Townhouse",
6
+ VILLA: "Villa",
7
+ CABIN: "Cabin",
8
+ COTTAGE: "Cottage",
9
+ BUNGALOW: "Bungalow",
10
+ FARMHOUSE: "Farmhouse",
11
+ RANCH: "Ranch",
12
+ LOFT: "Loft",
13
+ STUDIO: "Studio",
14
+ DUPLEX: "Duplex",
15
+ TRIPLEX: "Triplex",
16
+ PENTHOUSE: "Penthouse",
17
+ CHALET: "Chalet",
18
+ CASTLE: "Castle",
19
+ BEACH_HOUSE: "Beach House",
20
+ HOUSEBOAT: "Houseboat",
21
+ YURT: "Yurt",
22
+ TREEHOUSE: "Treehouse",
23
+ OTHER: "Other",
24
+ };
1
25
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@turndown/library",
3
- "version": "0.0.50",
3
+ "version": "0.0.52",
4
4
  "description": "Shared TypeScript library for the Turndown suite.",
5
5
  "keywords": [
6
6
  "types",