@aptly-as/types 2.3.3 → 2.4.0

package/core/fields.d.ts

@@ -1,7 +1,9 @@
 import { AptlyFieldType } from '../enums/index.js';
-export interface AptlyField {
+export type AptlyDraftJS = string;
+export type AptlyMarkdown = string;
+export interface AptlyField<L = string> {
     type: AptlyFieldType;
-    label: string;
+    label: L;
     placeholder?: string;
     required?: boolean;
     pattern?: string;

package/core/scope.d.ts

@@ -4,6 +4,7 @@ export declare enum AptlyModules {
     Core = "core",
     Default = "default",
     Departments = "departments",
+    Emails = "emails",
     OptionLabels = "optionLabels",
     Pages = "pages",
     Payment = "payment",
@@ -56,6 +57,7 @@ export declare enum AptlyScopes {
     ProjectAlgorithms = "projectAlgorithms",
     ProjectBooking = "projectBooking",
     ProjectDocuments = "projectDocuments",
+    ProjectEmails = "projectEmails",
     ProjectInquiry = "projectInquiry",
     ProjectInquiryComplaint = "projectInquiryComplaint",
     ProjectOrders = "projectOrders",

package/core/scope.js

@@ -5,6 +5,7 @@ export var AptlyModules;
     AptlyModules["Core"] = "core";
     AptlyModules["Default"] = "default";
     AptlyModules["Departments"] = "departments";
+    AptlyModules["Emails"] = "emails";
     AptlyModules["OptionLabels"] = "optionLabels";
     AptlyModules["Pages"] = "pages";
     AptlyModules["Payment"] = "payment";
@@ -58,6 +59,7 @@ export var AptlyScopes;
     AptlyScopes["ProjectAlgorithms"] = "projectAlgorithms";
     AptlyScopes["ProjectBooking"] = "projectBooking";
     AptlyScopes["ProjectDocuments"] = "projectDocuments";
+    AptlyScopes["ProjectEmails"] = "projectEmails";
     AptlyScopes["ProjectInquiry"] = "projectInquiry";
     AptlyScopes["ProjectInquiryComplaint"] = "projectInquiryComplaint";
     AptlyScopes["ProjectOrders"] = "projectOrders";

package/enums/fields.d.ts

@@ -1,27 +1,28 @@
 export declare enum AptlyFieldType {
-    Object = "object",
-    Images = "images",
-    Image = "image",
-    Media = "media",
-    Text = "text",
-    StringArray = "string-array",
-    Password = "password",
-    TextArea = "text-area",
-    Email = "email",
-    Number = "number",
+    BulkIds = "bulk-ids",
+    Checkbox = "checkbox",
+    Custom = "custom",
+    Color = "color",
     Date = "date",
     DateTime = "date-time",
-    Color = "color",
-    Select = "select",
-    File = "file",
-    Files = "files",
     Documents = "documents",
     DraftJS = "draft-js",
-    Reference = "reference",
-    Custom = "custom",
-    BulkIds = "bulk-ids",
+    Email = "email",
+    File = "file",
+    Files = "files",
     Hidden = "hidden",
+    Images = "images",
+    Image = "image",
+    Markdown = "markdown",
+    Media = "media",
+    Number = "number",
+    Object = "object",
+    Password = "password",
+    Reference = "reference",
+    StringArray = "string-array",
+    Select = "select",
     Sort = "sort",
     Switch = "switch",
-    Checkbox = "checkbox"
+    Text = "text",
+    TextArea = "text-area"
 }

package/enums/fields.js

@@ -1,28 +1,29 @@
 export var AptlyFieldType;
 (function (AptlyFieldType) {
-    AptlyFieldType["Object"] = "object";
-    AptlyFieldType["Images"] = "images";
-    AptlyFieldType["Image"] = "image";
-    AptlyFieldType["Media"] = "media";
-    AptlyFieldType["Text"] = "text";
-    AptlyFieldType["StringArray"] = "string-array";
-    AptlyFieldType["Password"] = "password";
-    AptlyFieldType["TextArea"] = "text-area";
-    AptlyFieldType["Email"] = "email";
-    AptlyFieldType["Number"] = "number";
+    AptlyFieldType["BulkIds"] = "bulk-ids";
+    AptlyFieldType["Checkbox"] = "checkbox";
+    AptlyFieldType["Custom"] = "custom";
+    AptlyFieldType["Color"] = "color";
     AptlyFieldType["Date"] = "date";
     AptlyFieldType["DateTime"] = "date-time";
-    AptlyFieldType["Color"] = "color";
-    AptlyFieldType["Select"] = "select";
-    AptlyFieldType["File"] = "file";
-    AptlyFieldType["Files"] = "files";
     AptlyFieldType["Documents"] = "documents";
     AptlyFieldType["DraftJS"] = "draft-js";
-    AptlyFieldType["Reference"] = "reference";
-    AptlyFieldType["Custom"] = "custom";
-    AptlyFieldType["BulkIds"] = "bulk-ids";
+    AptlyFieldType["Email"] = "email";
+    AptlyFieldType["File"] = "file";
+    AptlyFieldType["Files"] = "files";
     AptlyFieldType["Hidden"] = "hidden";
+    AptlyFieldType["Images"] = "images";
+    AptlyFieldType["Image"] = "image";
+    AptlyFieldType["Markdown"] = "markdown";
+    AptlyFieldType["Media"] = "media";
+    AptlyFieldType["Number"] = "number";
+    AptlyFieldType["Object"] = "object";
+    AptlyFieldType["Password"] = "password";
+    AptlyFieldType["Reference"] = "reference";
+    AptlyFieldType["StringArray"] = "string-array";
+    AptlyFieldType["Select"] = "select";
     AptlyFieldType["Sort"] = "sort";
     AptlyFieldType["Switch"] = "switch";
-    AptlyFieldType["Checkbox"] = "checkbox";
+    AptlyFieldType["Text"] = "text";
+    AptlyFieldType["TextArea"] = "text-area";
 })(AptlyFieldType || (AptlyFieldType = {}));

package/enums/index.d.ts

@@ -124,3 +124,20 @@ export declare enum AptlyOrganizationStatus {
     Paused = 3,
     Closed = 4
 }
+export declare enum AptlyEmailType {
+    Invite = "invite",
+    Inquiry = "inquiry",
+    NewOwner = "new-owner",
+    PeriodOpen = "period-open",
+    PeriodClose = "period-close",
+    BookingConfirm = "booking-confirm",
+    BookingCancel = "booking-cancel",
+    OrderCreated = "order-created",
+    OrderSign = "order-sign",
+    OrderSigned = "order-signed",
+    OrderPay = "order-pay",
+    OrderPayed = "order-payed",
+    OrderReceipt = "order-receipt",
+    OrderCompleted = "order-completed",
+    ActionRecipients = "action_recipients"
+}

package/enums/index.js

@@ -143,3 +143,21 @@ export var AptlyOrganizationStatus;
     AptlyOrganizationStatus[AptlyOrganizationStatus["Paused"] = 3] = "Paused";
     AptlyOrganizationStatus[AptlyOrganizationStatus["Closed"] = 4] = "Closed";
 })(AptlyOrganizationStatus || (AptlyOrganizationStatus = {}));
+export var AptlyEmailType;
+(function (AptlyEmailType) {
+    AptlyEmailType["Invite"] = "invite";
+    AptlyEmailType["Inquiry"] = "inquiry";
+    AptlyEmailType["NewOwner"] = "new-owner";
+    AptlyEmailType["PeriodOpen"] = "period-open";
+    AptlyEmailType["PeriodClose"] = "period-close";
+    AptlyEmailType["BookingConfirm"] = "booking-confirm";
+    AptlyEmailType["BookingCancel"] = "booking-cancel";
+    AptlyEmailType["OrderCreated"] = "order-created";
+    AptlyEmailType["OrderSign"] = "order-sign";
+    AptlyEmailType["OrderSigned"] = "order-signed";
+    AptlyEmailType["OrderPay"] = "order-pay";
+    AptlyEmailType["OrderPayed"] = "order-payed";
+    AptlyEmailType["OrderReceipt"] = "order-receipt";
+    AptlyEmailType["OrderCompleted"] = "order-completed";
+    AptlyEmailType["ActionRecipients"] = "action_recipients";
+})(AptlyEmailType || (AptlyEmailType = {}));

package/models/email.d.ts

@@ -0,0 +1,16 @@
+import { AptlyEmailType } from '../enums/index.js';
+import { AptlyMarkdown } from '../core';
+export type AptlyEmail = AptlyEmailSchema<string, string>;
+export interface AptlyEmailSchema<ID, DATE> {
+    _id: ID;
+    name: string;
+    type: AptlyEmailType;
+    subject: string;
+    content: AptlyMarkdown;
+    actionLabel?: string;
+    organization: ID;
+    project?: ID;
+    archived: boolean;
+    createdAt: DATE;
+    updatedAt: DATE;
+}

package/models/email.js

@@ -0,0 +1 @@
+export {};

package/models/extends.d.ts

@@ -28,7 +28,10 @@ export interface AptlyDBCrawlerCleaner {
     lastClean?: boolean;
 }
 export interface AptlyAddress {
+    line1?: string;
+    line2?: string;
     street?: string;
     zip?: string;
     city?: string;
+    country?: string;
 }

package/models/index.d.ts

@@ -4,6 +4,7 @@ export * from './booking.js';
 export * from './client.js';
 export * from './department.js';
 export * from './document.js';
+export * from './email.js';
 export * from './extends.js';
 export * from './inquiry.js';
 export * from './media.js';

package/models/index.js

@@ -4,6 +4,7 @@ export * from './booking.js';
 export * from './client.js';
 export * from './department.js';
 export * from './document.js';
+export * from './email.js';
 export * from './extends.js';
 export * from './inquiry.js';
 export * from './media.js';

package/models/order.d.ts

@@ -1,6 +1,7 @@
 import { AptlyOrderStatus } from '../enums/index.js';
 import { AptlyAppImplementationSetting, AptlyAppSchema } from './app.js';
 import { AptlyDocumentSchema } from './document.js';
+import { AptlyEmailSchema } from './email.js';
 import { AptlyOrganizationAppConfigSchema, AptlyOrganizationSchema } from './organization.js';
 import { AptlyProductSchema } from './product.js';
 import { AptlyProject, AptlyProjectPeriodSchema, AptlyProjectSchema } from './project.js';
@@ -118,6 +119,7 @@ export interface AptlyOrderActionPostBody {
     app?: string;
     emailSubject: string;
     emailText: string;
+    emailMarkdown: string;
     users: AptlyOrderActionPostBodyUser[];
     deadlineInDays?: number;
 }
@@ -132,6 +134,7 @@ export interface AptlyOrderActionItemSchema<ID, DATE, S extends object> {
     path: string;
     app?: Pick<AptlyAppSchema<ID, DATE>, '_id' | 'name' | 'sign' | 'logo' | 'settings'>;
     appSettings?: AptlyOrganizationAppConfigSchema<ID, DATE, S>['settings'];
+    email?: AptlyEmailSchema<ID, DATE>;
 }
 export interface AptlyOrderActionItemSignSettings {
     [AptlyAppImplementationSetting.SignCostPer]: number;

package/models/organization.d.ts

@@ -13,6 +13,7 @@ export type AptlyOrganization = AptlyOrganizationSchema<string, string>;
 export interface AptlyOrganizationSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE>, AptlyHistorySchema<ID, DATE> {
     slug: string;
     number?: string;
+    vat?: string;
     logo?: string | null;
     logoMedia?: AptlyMediaSrc | null;
     negativeLogoMedia?: AptlyMediaSrc | null;

package/models/project.d.ts

@@ -1,4 +1,4 @@
-import { AptlyProjectStatus } from '../enums/index.js';
+import { AptlyEmailType, AptlyProjectStatus } from '../enums/index.js';
 import { AptlyAlgorithm, AptlyAlgorithmPipeline, AptlyAlgorithmPipelineSchema, AptlyAlgorithmSchema } from './algorithm.js';
 import { AptlyAppSchema } from './app.js';
 import { AptlyOrganizationSchema } from './organization.js';
@@ -97,6 +97,7 @@ export type AptlyProjectNotify = AptlyProjectNotifySchema<string, string>;
 interface AptlyProjectNotifySchema<ID, DATE> {
     _id: ID;
     user: AptlyUserSchema<ID, DATE> | ID;
+    types?: AptlyEmailType[];
     inquiry: boolean;
     booking: boolean;
     complaint: boolean;

package/models/unit-email.d.ts

@@ -1,3 +1,4 @@
+import { AptlyEmailType } from '../enums/index.js';
 import { AptlyBookingSchema } from './booking.js';
 import { AptlyBaseSchema } from './extends.js';
 import { AptlyInquirySchema } from './inquiry.js';
@@ -6,7 +7,7 @@ import { AptlyProjectSchema } from './project.js';
 import { AptlyUnitSchema } from './unit.js';
 export type AptlyUnitEmail = AptlyUnitEmailSchema<string, string>;
 export interface AptlyUnitEmailSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
-    type: AptlyUnitEmailType;
+    type: AptlyEmailType;
     to: string[];
     subject: string;
     references: string;
@@ -18,16 +19,3 @@ export interface AptlyUnitEmailSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID,
     booking?: ID | AptlyBookingSchema<ID, DATE>;
     created: DATE;
 }
-export declare enum AptlyUnitEmailType {
-    Inquiry = "inquiry",
-    Invite = "invite",
-    NewOwner = "new-owner",
-    PeriodOpen = "period-open",
-    PeriodClose = "period-close",
-    BookingConfirm = "booking-confirm",
-    BookingCancel = "booking-cancel",
-    OrderCreated = "order-created",
-    OrderSigned = "order-signed",
-    OrderCompleted = "order-completed",
-    ActionRecipients = "action_recipients"
-}

package/models/unit-email.js

@@ -1,14 +1 @@
-export var AptlyUnitEmailType;
-(function (AptlyUnitEmailType) {
-    AptlyUnitEmailType["Inquiry"] = "inquiry";
-    AptlyUnitEmailType["Invite"] = "invite";
-    AptlyUnitEmailType["NewOwner"] = "new-owner";
-    AptlyUnitEmailType["PeriodOpen"] = "period-open";
-    AptlyUnitEmailType["PeriodClose"] = "period-close";
-    AptlyUnitEmailType["BookingConfirm"] = "booking-confirm";
-    AptlyUnitEmailType["BookingCancel"] = "booking-cancel";
-    AptlyUnitEmailType["OrderCreated"] = "order-created";
-    AptlyUnitEmailType["OrderSigned"] = "order-signed";
-    AptlyUnitEmailType["OrderCompleted"] = "order-completed";
-    AptlyUnitEmailType["ActionRecipients"] = "action_recipients";
-})(AptlyUnitEmailType || (AptlyUnitEmailType = {}));
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptly-as/types",
-  "version": "2.3.3",
+  "version": "2.4.0",
   "description": "Aptly types and enums",
   "type": "module",
   "main": "./index.js",