@aptly-as/types 2.2.0 → 2.2.2

package/core/index.d.ts

@@ -3,8 +3,9 @@ import { AptlyCloudinaryFile } from './cloudinary.js';
 export * from './api.js';
 export * from './app.js';
 export * from './cloudinary.js';
+export * from './job.js';
+export * from './redirect.js';
 export * from './scope.js';
-export * from './error.js';
 export * from './fields.js';
 export * from './signage.js';
 export * from './webhook-event-data.js';

package/core/index.js

@@ -1,8 +1,9 @@
 export * from './api.js';
 export * from './app.js';
 export * from './cloudinary.js';
+export * from './job.js';
+export * from './redirect.js';
 export * from './scope.js';
-export * from './error.js';
 export * from './fields.js';
 export * from './signage.js';
 export * from './webhook-event-data.js';

package/core/job.d.ts

@@ -0,0 +1,20 @@
+import { AptlyOrder } from '../models/index.js';
+export declare enum AptlyJobQueue {
+    Documents = "documents",
+    Orders = "orders",
+    Units = "units"
+}
+export declare enum AptlyJobName {
+    ZipDocuments = "zip-documents",
+    Create = "create"
+}
+export interface AptlyJob<DATA = any, RETURN = any> {
+    id: string;
+    name: AptlyJobName;
+    progress: number;
+    data: DATA;
+    returnvalue: RETURN;
+}
+export type AptlyJobOrder = AptlyJob<any, {
+    order: AptlyOrder;
+}>;

package/core/job.js

@@ -0,0 +1,11 @@
+export var AptlyJobQueue;
+(function (AptlyJobQueue) {
+    AptlyJobQueue["Documents"] = "documents";
+    AptlyJobQueue["Orders"] = "orders";
+    AptlyJobQueue["Units"] = "units";
+})(AptlyJobQueue || (AptlyJobQueue = {}));
+export var AptlyJobName;
+(function (AptlyJobName) {
+    AptlyJobName["ZipDocuments"] = "zip-documents";
+    AptlyJobName["Create"] = "create";
+})(AptlyJobName || (AptlyJobName = {}));

package/core/redirect.d.ts

@@ -0,0 +1,14 @@
+export declare enum AptlyRedirectAction {
+    Sign = "sign"
+}
+export declare enum AptlyRedirectActionError {
+    SignCancel = "signCancel",
+    SignError = "signError"
+}
+export type AptlyRedirectOptions = {
+    action: AptlyRedirectAction;
+    error?: AptlyRedirectActionError;
+    error_description?: string;
+};
+export type AptlyClientRedirectOptions = Record<'unit', string> & Partial<Record<'period', string>> & AptlyRedirectOptions;
+export type AptlyDashboardRedirectOptions = Record<'organization' | 'project', string> & AptlyRedirectOptions;

package/core/redirect.js

@@ -0,0 +1,9 @@
+export var AptlyRedirectAction;
+(function (AptlyRedirectAction) {
+    AptlyRedirectAction["Sign"] = "sign";
+})(AptlyRedirectAction || (AptlyRedirectAction = {}));
+export var AptlyRedirectActionError;
+(function (AptlyRedirectActionError) {
+    AptlyRedirectActionError["SignCancel"] = "signCancel";
+    AptlyRedirectActionError["SignError"] = "signError";
+})(AptlyRedirectActionError || (AptlyRedirectActionError = {}));

package/error/error.d.ts

@@ -0,0 +1,28 @@
+export interface AptlyErrorBody {
+    name: 'AptlyError';
+    status: number;
+    title: string;
+    id?: string;
+    code?: number;
+    detail?: string;
+    errors?: AptlyErrorBodySimple[];
+    link?: string;
+    error?: string;
+}
+export type AptlyErrorBodySimple = Pick<AptlyErrorBody, 'status' | 'title' | 'detail' | 'link'>;
+export declare class AptlyError extends Error {
+    readonly data: Omit<AptlyErrorBody, 'name'>;
+    readonly error?: Error | undefined;
+    readonly name = "AptlyError";
+    id: string;
+    constructor(data: Omit<AptlyErrorBody, 'name'>, error?: Error | undefined);
+    static fromFetchResponse(response: Response): Promise<AptlyError>;
+    get status(): number;
+    get title(): string;
+    get code(): number | undefined;
+    get detail(): string | undefined;
+    get link(): string | undefined;
+    get errors(): AptlyErrorBodySimple[];
+    toJSON(): AptlyErrorBody;
+    toString(): string;
+}

package/error/error.js

@@ -0,0 +1,50 @@
+export class AptlyError extends Error {
+    constructor(data, error) {
+        super(data.title);
+        this.data = data;
+        this.error = error;
+        this.name = 'AptlyError';
+        this.id = data.id || '';
+    }
+    static async fromFetchResponse(response) {
+        if (response.headers.get('content-type') !== 'application/json') {
+            const body = await response.json();
+            if (body.name === AptlyError.name) {
+                return new AptlyError(body);
+            }
+        }
+        throw new AptlyError({
+            id: 'unknown',
+            status: response.status,
+            title: response.statusText,
+            detail: `Failed to fetch from url: ${response.url}`,
+        });
+    }
+    get status() {
+        return this.data.status;
+    }
+    get title() {
+        return this.data.title;
+    }
+    get code() {
+        return this.data.code;
+    }
+    get detail() {
+        return this.data.detail;
+    }
+    get link() {
+        return this.data.link;
+    }
+    get errors() {
+        return this.data.errors || [];
+    }
+    toJSON() {
+        return {
+            name: this.name,
+            ...this.data,
+        };
+    }
+    toString() {
+        return this.message;
+    }
+}

package/error/index.d.ts

@@ -0,0 +1 @@
+export * from './error.js';

package/error/index.js

@@ -0,0 +1 @@
+export * from './error.js';

package/index.d.ts

@@ -1,3 +1,4 @@
 export * from './core/index.js';
 export * from './enums/index.js';
+export * from './error/index.js';
 export * from './models/index.js';

package/index.js

@@ -1,3 +1,4 @@
 export * from './core/index.js';
 export * from './enums/index.js';
+export * from './error/index.js';
 export * from './models/index.js';

package/models/order.d.ts

@@ -2,7 +2,7 @@ import { AptlyOrderStatus } from '../enums/index.js';
 import { AptlyAppSchema } from './app.js';
 import { AptlyDocumentSchema } from './document.js';
 import { AptlyOrganizationSchema } from './organization.js';
-import { AptlyProjectPeriodSchema, AptlyProjectSchema } from './project.js';
+import { AptlyProject, AptlyProjectPeriodSchema, AptlyProjectSchema } from './project.js';
 import { AptlyUnit, AptlyUnitItemParamSchema, AptlyUnitSchema } from './unit.js';
 import { AptlyBaseSchema } from './extends.js';
 import { AptlyUser, AptlyUserSchema } from './user.js';
@@ -16,13 +16,14 @@ export interface AptlyOrderSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DAT
     signers: (ID | AptlyUserSchema<ID, DATE>)[];
     status: AptlyOrderStatus;
     receipt: ID | AptlyDocumentSchema<ID, DATE>;
-    signedReceipt?: ID;
+    signedReceipt?: ID | AptlyDocumentSchema<ID, DATE>;
     attachments: ID[];
     signage: AptlyOrderSignageSchema<ID, DATE>;
     items: AptlyOrderItemSchema<ID, DATE>[];
     totalCost: number;
     pricePipeline: AptlyOrderPricePipelineItemSchema<ID>[];
     signees: AptlyOrderSigneeSchema<ID, DATE>[];
+    emailText?: string;
     created: DATE;
 }
 export type AptlyOrderSignee = AptlyOrderSigneeSchema<string, string>;
@@ -87,9 +88,12 @@ export interface AptlyOrderActionItemSchema<ID, DATE> {
     costPerSign?: number;
 }
 export interface AptlyOrderActionSignData {
-    project: string;
+    project: Pick<AptlyProject, '_id' | 'name'> & {
+        theme: Pick<AptlyProject['theme'], 'contact'>;
+    };
     unit: Pick<AptlyUnit, '_id' | 'name'>;
-    order: Pick<AptlyOrder, '_id' | 'orderNumber' | 'receipt'>;
-    users: Pick<AptlyUser, '_id' | 'firstName' | 'lastName' | 'fullName' | 'email' | 'phone'>[];
-    admins: Pick<AptlyUser, '_id' | 'firstName' | 'lastName' | 'fullName' | 'email' | 'phone'>[];
+    order: Pick<AptlyOrder, '_id' | 'orderNumber' | 'receipt' | 'period'>;
+    users: Pick<AptlyUser, '_id' | 'firstName' | 'lastName' | 'fullName' | 'email' | 'phone' | 'language' | 'profileImage'>[];
+    admins: Pick<AptlyUser, '_id' | 'firstName' | 'lastName' | 'fullName' | 'email' | 'phone' | 'language' | 'profileImage'>[];
+    emailText?: string;
 }

package/models/unit-email.d.ts

@@ -27,5 +27,6 @@ export declare enum AptlyUnitEmailType {
     BookingConfirm = "booking-confirm",
     BookingCancel = "booking-cancel",
     OrderCreated = "order-created",
-    OrderSigned = "order-signed"
+    OrderSigned = "order-signed",
+    OrderCompleted = "order-completed"
 }

package/models/unit-email.js

@@ -9,4 +9,5 @@ export var AptlyUnitEmailType;
     AptlyUnitEmailType["BookingCancel"] = "booking-cancel";
     AptlyUnitEmailType["OrderCreated"] = "order-created";
     AptlyUnitEmailType["OrderSigned"] = "order-signed";
+    AptlyUnitEmailType["OrderCompleted"] = "order-completed";
 })(AptlyUnitEmailType || (AptlyUnitEmailType = {}));

package/models/user.d.ts

@@ -1,5 +1,10 @@
 import { AptlyUserRoles } from '../core/index.js';
 import { AptlyBaseSchema } from './extends.js';
+export declare enum AptlyLanguage {
+    English = "en",
+    Norwegian = "no",
+    NorwegianBokmal = "nb"
+}
 export type AptlyUser = AptlyUserSchema<string, string>;
 export interface AptlyUserSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'archived' | 'name'> {
     email: string;
@@ -9,6 +14,7 @@ export interface AptlyUserSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE
     profileImage: string | null;
     permissions: AptlyUserRoles[];
     roles: AptlyUserRoles[];
+    language?: AptlyLanguage;
     gdpr: boolean;
     phone: string;
     synced: DATE;

package/models/user.js

@@ -1 +1,6 @@
-export {};
+export var AptlyLanguage;
+(function (AptlyLanguage) {
+    AptlyLanguage["English"] = "en";
+    AptlyLanguage["Norwegian"] = "no";
+    AptlyLanguage["NorwegianBokmal"] = "nb";
+})(AptlyLanguage || (AptlyLanguage = {}));

package/package.json

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

package/core/error.d.ts

@@ -1,43 +0,0 @@
-import { AptlyErrorCode } from '../enums/index.js';
-export type AptlyErrorSimple = Pick<AptlyError, 'status' | 'title' | 'detail' | 'link'>;
-export interface AptlyError {
-    id: string;
-    status: string;
-    code: AptlyErrorCode;
-    title: string;
-    detail?: string;
-    errors?: AptlyErrorSimple[];
-    link?: string;
-    links?: {
-        self?: AptlyErrorLink | string;
-    };
-    source?: {
-        pointer?: string;
-        parameter?: string;
-        header?: string;
-        body?: string;
-    };
-    meta?: object;
-}
-export interface AptlyErrorLink {
-    href: string;
-    title?: string;
-    describedBy?: string;
-    meta: {
-        count: number;
-    };
-}
-export declare class AptlyApiError<R> extends Error {
-    readonly id: string;
-    readonly status: string;
-    readonly detail: string;
-    readonly link: string;
-    readonly code: AptlyErrorCode;
-    readonly error?: Error;
-    readonly errors?: AptlyErrorSimple[];
-    readonly response?: R;
-    constructor(error: AptlyError & {
-        error?: Error;
-        response?: R;
-    });
-}

package/core/error.js

@@ -1,13 +0,0 @@
-export class AptlyApiError extends Error {
-    constructor(error) {
-        super(error.title);
-        this.id = error.id;
-        this.status = error.status;
-        this.detail = error.detail || '';
-        this.link = error.link || '';
-        this.code = error.code;
-        this.error = error.error;
-        this.errors = error.errors;
-        this.response = error.response;
-    }
-}

package/core/permission.d.ts

@@ -1,101 +0,0 @@
-export declare enum AptlyModule {
-    Algorithms = "algorithms",
-    Booking = "booking",
-    Core = "core",
-    Default = "default",
-    Departments = "departments",
-    OptionLabels = "optionLabels",
-    Pages = "pages",
-    ProductsExtended = "productsExtended",
-    Recommendations = "recommendations",
-    Subcontractor = "subcontractor",
-    Support = "support",
-    Testing = "testing",
-    UnitExtraOptions = "unitExtraOptions",
-    UnitExtraFields = "unitExtraFields"
-}
-export declare enum AptlyScope {
-    Admin = "admin",
-    AdminBilling = "adminBilling",
-    AdminProducers = "adminProducers",
-    AdminProducts = "adminProducts",
-    AdminReport = "adminReport",
-    AdminStats = "adminStats",
-    AdminSuppliers = "adminSuppliers",
-    AdminTags = "adminTags",
-    AdminTesting = "adminTesting",
-    AdminUsers = "adminUsers",
-    AdminOrganizations = "adminOrganizations",
-    Beta = "beta",
-    Organization = "organization",
-    OrganizationAlgorithms = "organizationAlgorithms",
-    OrganizationBooking = "organizationBooking",
-    OrganizationClients = "organizationClients",
-    OrganizationDepartments = "organizationDepartments",
-    OrganizationLogo = "organizationLogo",
-    OrganizationMembers = "organizationMembers",
-    OrganizationOptionLabels = "organizationOptionLabels",
-    OrganizationOrders = "organizationOrders",
-    OrganizationPages = "organizationPages",
-    OrganizationProducts = "organizationProducts",
-    OrganizationProductsExtended = "organizationProductsExtended",
-    OrganizationRecommendations = "organizationRecommendations",
-    OrganizationReport = "organizationReport",
-    OrganizationStats = "organizationStats",
-    OrganizationUnitTemplates = "organizationUnitTemplates",
-    OrganizationUpsellTemplates = "organizationUpsellTemplates",
-    OrganizationWebhooks = "organizationWebhooks",
-    Project = "project",
-    ProjectAlgorithms = "projectAlgorithms",
-    ProjectBooking = "projectBooking",
-    ProjectDocuments = "projectDocuments",
-    ProjectInquiry = "projectInquiry",
-    ProjectOrders = "projectOrders",
-    ProjectPages = "projectPages",
-    ProjectPeriods = "projectPeriods",
-    ProjectProducts = "projectProducts",
-    ProjectRecommendations = "projectRecommendations",
-    ProjectReport = "projectReport",
-    ProjectReportPrice = "projectReportPrice",
-    ProjectTheme = "projectTheme",
-    ProjectSigning = "projectSigning",
-    ProjectSubcontractor = "projectSubcontractor",
-    ProjectUnits = "projectUnits",
-    ProjectUnitInvites = "projectUnitInvites",
-    ProjectUnitExtraFields = "projectUnitExtraFields",
-    ProjectUnitExtraOptions = "projectUnitExtraOptions",
-    ProjectUnitTemplates = "projectUnitTemplates",
-    ProjectUnitTemplatesAlgorithms = "projectUnitTemplatesAlgorithms",
-    ProjectUnitTemplatesPrices = "projectUnitTemplatesPrices",
-    ProjectUpsellTemplates = "projectUpsellTemplates",
-    Unit = "unit",
-    UnitBooking = "unitBooking",
-    UnitInquiry = "unitInquiry",
-    UnitNotes = "unitNotes",
-    UnitOrders = "unitOrders",
-    UnitPages = "unitPages",
-    UnitProducts = "unitProducts",
-    UnitReport = "unitReport"
-}
-export declare enum AptlyUserRole {
-    Admin = "admin",
-    Beta = "beta",
-    Default = "default",
-    SuperAdmin = "superAdmin"
-}
-export declare enum AptlyOrganizationRole {
-    Admin = "admin",
-    Content = "content",
-    OrganizationContent = "organizationContent",
-    Default = "default",
-    ProjectAdmin = "projectAdmin",
-    TestingAdmin = "testingAdmin",
-    Reports = "reports",
-    Support = "support",
-    ThirdParty = "thirdParty"
-}
-export type AptlyScopeCrud = 'C' | 'R' | 'U' | 'D';
-export type AptlyScopeSchemaValue = 'C' | 'CR' | 'CRU' | 'CRUD' | 'R' | 'RU' | 'RUD' | 'U' | 'UD' | 'D';
-export type AptlyScopeSchema = {
-    [key in AptlyScope]: AptlyScopeSchemaValue;
-};

package/core/permission.js

@@ -1,100 +0,0 @@
-export var AptlyModule;
-(function (AptlyModule) {
-    AptlyModule["Algorithms"] = "algorithms";
-    AptlyModule["Booking"] = "booking";
-    AptlyModule["Core"] = "core";
-    AptlyModule["Default"] = "default";
-    AptlyModule["Departments"] = "departments";
-    AptlyModule["OptionLabels"] = "optionLabels";
-    AptlyModule["Pages"] = "pages";
-    AptlyModule["ProductsExtended"] = "productsExtended";
-    AptlyModule["Recommendations"] = "recommendations";
-    AptlyModule["Subcontractor"] = "subcontractor";
-    AptlyModule["Support"] = "support";
-    AptlyModule["Testing"] = "testing";
-    AptlyModule["UnitExtraOptions"] = "unitExtraOptions";
-    AptlyModule["UnitExtraFields"] = "unitExtraFields";
-})(AptlyModule || (AptlyModule = {}));
-export var AptlyScope;
-(function (AptlyScope) {
-    AptlyScope["Admin"] = "admin";
-    AptlyScope["AdminBilling"] = "adminBilling";
-    AptlyScope["AdminProducers"] = "adminProducers";
-    AptlyScope["AdminProducts"] = "adminProducts";
-    AptlyScope["AdminReport"] = "adminReport";
-    AptlyScope["AdminStats"] = "adminStats";
-    AptlyScope["AdminSuppliers"] = "adminSuppliers";
-    AptlyScope["AdminTags"] = "adminTags";
-    AptlyScope["AdminTesting"] = "adminTesting";
-    AptlyScope["AdminUsers"] = "adminUsers";
-    AptlyScope["AdminOrganizations"] = "adminOrganizations";
-    AptlyScope["Beta"] = "beta";
-    AptlyScope["Organization"] = "organization";
-    AptlyScope["OrganizationAlgorithms"] = "organizationAlgorithms";
-    AptlyScope["OrganizationBooking"] = "organizationBooking";
-    AptlyScope["OrganizationClients"] = "organizationClients";
-    AptlyScope["OrganizationDepartments"] = "organizationDepartments";
-    AptlyScope["OrganizationLogo"] = "organizationLogo";
-    AptlyScope["OrganizationMembers"] = "organizationMembers";
-    AptlyScope["OrganizationOptionLabels"] = "organizationOptionLabels";
-    AptlyScope["OrganizationOrders"] = "organizationOrders";
-    AptlyScope["OrganizationPages"] = "organizationPages";
-    AptlyScope["OrganizationProducts"] = "organizationProducts";
-    AptlyScope["OrganizationProductsExtended"] = "organizationProductsExtended";
-    AptlyScope["OrganizationRecommendations"] = "organizationRecommendations";
-    AptlyScope["OrganizationReport"] = "organizationReport";
-    AptlyScope["OrganizationStats"] = "organizationStats";
-    AptlyScope["OrganizationUnitTemplates"] = "organizationUnitTemplates";
-    AptlyScope["OrganizationUpsellTemplates"] = "organizationUpsellTemplates";
-    AptlyScope["OrganizationWebhooks"] = "organizationWebhooks";
-    AptlyScope["Project"] = "project";
-    AptlyScope["ProjectAlgorithms"] = "projectAlgorithms";
-    AptlyScope["ProjectBooking"] = "projectBooking";
-    AptlyScope["ProjectDocuments"] = "projectDocuments";
-    AptlyScope["ProjectInquiry"] = "projectInquiry";
-    AptlyScope["ProjectOrders"] = "projectOrders";
-    AptlyScope["ProjectPages"] = "projectPages";
-    AptlyScope["ProjectPeriods"] = "projectPeriods";
-    AptlyScope["ProjectProducts"] = "projectProducts";
-    AptlyScope["ProjectRecommendations"] = "projectRecommendations";
-    AptlyScope["ProjectReport"] = "projectReport";
-    AptlyScope["ProjectReportPrice"] = "projectReportPrice";
-    AptlyScope["ProjectTheme"] = "projectTheme";
-    AptlyScope["ProjectSigning"] = "projectSigning";
-    AptlyScope["ProjectSubcontractor"] = "projectSubcontractor";
-    AptlyScope["ProjectUnits"] = "projectUnits";
-    AptlyScope["ProjectUnitInvites"] = "projectUnitInvites";
-    AptlyScope["ProjectUnitExtraFields"] = "projectUnitExtraFields";
-    AptlyScope["ProjectUnitExtraOptions"] = "projectUnitExtraOptions";
-    AptlyScope["ProjectUnitTemplates"] = "projectUnitTemplates";
-    AptlyScope["ProjectUnitTemplatesAlgorithms"] = "projectUnitTemplatesAlgorithms";
-    AptlyScope["ProjectUnitTemplatesPrices"] = "projectUnitTemplatesPrices";
-    AptlyScope["ProjectUpsellTemplates"] = "projectUpsellTemplates";
-    AptlyScope["Unit"] = "unit";
-    AptlyScope["UnitBooking"] = "unitBooking";
-    AptlyScope["UnitInquiry"] = "unitInquiry";
-    AptlyScope["UnitNotes"] = "unitNotes";
-    AptlyScope["UnitOrders"] = "unitOrders";
-    AptlyScope["UnitPages"] = "unitPages";
-    AptlyScope["UnitProducts"] = "unitProducts";
-    AptlyScope["UnitReport"] = "unitReport";
-})(AptlyScope || (AptlyScope = {}));
-export var AptlyUserRole;
-(function (AptlyUserRole) {
-    AptlyUserRole["Admin"] = "admin";
-    AptlyUserRole["Beta"] = "beta";
-    AptlyUserRole["Default"] = "default";
-    AptlyUserRole["SuperAdmin"] = "superAdmin";
-})(AptlyUserRole || (AptlyUserRole = {}));
-export var AptlyOrganizationRole;
-(function (AptlyOrganizationRole) {
-    AptlyOrganizationRole["Admin"] = "admin";
-    AptlyOrganizationRole["Content"] = "content";
-    AptlyOrganizationRole["OrganizationContent"] = "organizationContent";
-    AptlyOrganizationRole["Default"] = "default";
-    AptlyOrganizationRole["ProjectAdmin"] = "projectAdmin";
-    AptlyOrganizationRole["TestingAdmin"] = "testingAdmin";
-    AptlyOrganizationRole["Reports"] = "reports";
-    AptlyOrganizationRole["Support"] = "support";
-    AptlyOrganizationRole["ThirdParty"] = "thirdParty";
-})(AptlyOrganizationRole || (AptlyOrganizationRole = {}));