@aptly-as/types 3.0.15 → 3.0.16

package/core/content.d.ts

@@ -0,0 +1,6 @@
+import { AptlyOrganizationContent, AptlyProjectContent } from '../models/index.js';
+export interface AptlyContentProps {
+    organization?: AptlyOrganizationContent;
+    project?: AptlyProjectContent;
+}
+export declare function useAptlyLogoSrc(content: AptlyContentProps): string;

package/core/content.js

@@ -0,0 +1,22 @@
+export function useAptlyLogoSrc(content) {
+    let src = '';
+    if (content.project && 'theme' in content.project) {
+        if (content.project.theme?.images) {
+            if (content.project.theme.images.logoMedia) {
+                src = content.project.theme.images.logoMedia.src;
+            }
+            else if (content.project.theme.images.logo) {
+                src = content.project.theme.images.logo;
+            }
+        }
+    }
+    if (!src && content.organization && 'name' in content.organization) {
+        if (content.organization.logoMedia) {
+            src = content.organization.logoMedia.src;
+        }
+        else if (content.organization.logo) {
+            src = content.organization.logo;
+        }
+    }
+    return src;
+}

package/core/index.d.ts

@@ -3,6 +3,7 @@ import { AptlyCloudinaryFile } from './cloudinary.js';
 export * from './api.js';
 export * from './app.js';
 export * from './cloudinary.js';
+export * from './content.js';
 export * from './job.js';
 export * from './mongoose.js';
 export * from './redirect.js';

package/core/index.js

@@ -1,6 +1,7 @@
 export * from './api.js';
 export * from './app.js';
 export * from './cloudinary.js';
+export * from './content.js';
 export * from './job.js';
 export * from './mongoose.js';
 export * from './redirect.js';

package/core/webhook-event-data.d.ts

@@ -1,35 +1,41 @@
-import { AptlyDocumentSchema, AptlyOrderSchema, AptlyPaymentSchema, AptlyPaymentSettlement, AptlyProjectSchema, AptlyUnitSchema } from '../models/index.js';
+import { AptlyDocumentSchema, AptlyOrderSchema, AptlyOrganizationSchema, AptlyPaymentSchema, AptlyPaymentSettlement, AptlyProjectSchema, AptlyUnitSchema } from '../models/index.js';
 export declare namespace AptlyWebhookEventData {
-    interface UnitWebhookSchema<ID, DATE> {
-        unit: Pick<AptlyUnitSchema<ID, DATE>, '_id' | 'name'>;
+    type Organization<ID, DATE> = Pick<AptlyOrganizationSchema<ID, DATE>, '_id' | 'name' | 'logoMedia' | 'logo'>;
+    type Project<ID, DATE> = Pick<AptlyProjectSchema<ID, DATE>, '_id' | 'name' | 'theme'>;
+    type Unit<ID, DATE> = Pick<AptlyUnitSchema<ID, DATE>, '_id' | 'name'>;
+    export interface UnitWebhookSchema<ID, DATE> {
+        unit: Unit<ID, DATE>;
     }
-    interface UnitDocumentWebhookSchema<ID, DATE> {
+    export interface UnitDocumentWebhookSchema<ID, DATE> {
         document: AptlyDocumentSchema<ID, DATE>;
         documentUrl: string;
     }
-    type Payment = PaymentSchema<string, string>;
-    interface PaymentSchema<ID, DATE> {
-        unit: Pick<AptlyUnitSchema<ID, DATE>, '_id' | 'name'>;
-        project: Pick<AptlyProjectSchema<ID, DATE>, '_id' | 'name'>;
+    export type Payment = PaymentSchema<string, string>;
+    export interface PaymentSchema<ID, DATE> {
+        organization: Organization<ID, DATE>;
+        project: Project<ID, DATE>;
+        unit: Unit<ID, DATE>;
         payment: AptlyPaymentSchema<ID, DATE>;
         order: Pick<AptlyOrderSchema<ID, DATE>, '_id' | 'orderNumber'>;
         documentUrl?: string;
         reportDocumentUrl?: string;
     }
-    type NewUnitDocument = NewUnitDocumentSchema<string, string>;
-    type NewUnitDocumentSchema<ID, DATE> = UnitWebhookSchema<ID, DATE> & UnitDocumentWebhookSchema<ID, DATE>;
-    type NewUnitOrder = NewUnitOrderSchema<string, string>;
-    interface NewUnitOrderSchema<ID, DATE> extends NewUnitDocumentSchema<ID, DATE> {
+    export type NewUnitDocument = NewUnitDocumentSchema<string, string>;
+    export type NewUnitDocumentSchema<ID, DATE> = UnitWebhookSchema<ID, DATE> & UnitDocumentWebhookSchema<ID, DATE>;
+    export type NewUnitOrder = NewUnitOrderSchema<string, string>;
+    export interface NewUnitOrderSchema<ID, DATE> extends NewUnitDocumentSchema<ID, DATE> {
         order: Pick<AptlyOrderSchema<ID, DATE>, '_id' | 'orderNumber' | 'receipt' | 'period'>;
     }
-    type Order = OrderSchema<string, string>;
-    interface OrderSchema<ID, DATE> {
-        project: Pick<AptlyProjectSchema<ID, DATE>, '_id' | 'name'>;
+    export type Order = OrderSchema<string, string>;
+    export interface OrderSchema<ID, DATE> {
+        organization: Organization<ID, DATE>;
+        project: Project<ID, DATE>;
         unit: Pick<AptlyUnitSchema<ID, DATE>, '_id' | 'name' | 'shipping' | 'users'>;
         order: AptlyOrderSchema<ID, DATE>;
         receiptUrl?: string;
         signedReceiptUrl?: string;
     }
+    export {};
 }
 export declare namespace AptlyAppWebhookEventData {
     interface SettlementCreate extends Pick<AptlyPaymentSettlement, 'app' | 'at' | 'externalId' | 'externalRef' | 'destination'> {

package/models/organization.d.ts

@@ -12,6 +12,8 @@ import { AptlyDepartmentGeneric } from './department.js';
 import { AptlyProducerSchema } from './producer.js';
 import { AptlyAppSchema } from './app.js';
 import { AptlyAlgorithmSchema } from './algorithm.js';
+export type AptlyOrganizationContent = AptlyOrganizationContentSchema<string, string>;
+export type AptlyOrganizationContentSchema<ID, DATE> = Pick<AptlyOrganizationSchema<ID, DATE>, '_id' | 'name' | 'logoMedia' | 'logo'>;
 export type AptlyOrganization = AptlyOrganizationSchema<string, string>;
 export interface AptlyOrganizationSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE>, AptlyHistorySchema<ID, DATE> {
     slug: string;

package/models/payment.d.ts

@@ -1,13 +1,13 @@
 import { AptlyAddress } from './address.js';
 import { AptlyAppSchema } from './app.js';
-import { AptlyCustomerSchema } from './customer.js';
+import { AptlyCustomer, AptlyCustomerSchema } from './customer.js';
 import { AptlyDocumentSchema } from './document.js';
 import { AptlyBaseSchema } from './extends.js';
-import { AptlyOrderPaymentStatus, AptlyOrderSchema } from './order.js';
-import { AptlyOrganizationSchema } from './organization.js';
+import { AptlyOrder, AptlyOrderPaymentStatus, AptlyOrderSchema } from './order.js';
+import { AptlyOrganizationContent, AptlyOrganizationSchema } from './organization.js';
 import { AptlyPickConfirmedSchema } from './pick.js';
-import { AptlyProjectSchema } from './project.js';
-import { AptlyUnitSchema } from './unit.js';
+import { AptlyProjectContent, AptlyProjectSchema } from './project.js';
+import { AptlyUnitContent, AptlyUnitSchema } from './unit.js';
 import { AptlyUserSchema } from './user.js';
 export type AptlyPayment = AptlyPaymentSchema<string, string>;
 export interface AptlyPaymentSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
@@ -88,6 +88,16 @@ export interface AptlyPaymentItemSchema<ID> {
     totalCost: number;
     totalVat: number;
 }
+export interface AptlyPaymentInitPaymentBody {
+    organization: AptlyOrganizationContent;
+    project: AptlyProjectContent;
+    unit: AptlyUnitContent;
+    order: AptlyOrder;
+    customer: AptlyCustomer;
+    shipping: AptlyAddress;
+    billing: AptlyAddress;
+    redirectUri: string;
+}
 export interface AptlyPaymentCaptureBody {
     id: string;
     status: AptlyOrderPaymentStatus;

package/models/project.d.ts

@@ -11,6 +11,8 @@ import { AptlyBaseSchema, AptlyHistorySchema } from './extends.js';
 import { AptlyDocumentSchema } from './document.js';
 import { AptlyUnitOptionExtraItemSchema } from './unit.js';
 import { AptlyMediaSrc } from './media.js';
+export type AptlyProjectContent = AptlyProjectContentSchema<string, string>;
+export type AptlyProjectContentSchema<ID, DATE> = Pick<AptlyProjectSchema<ID, DATE>, '_id' | 'name' | 'theme'>;
 export type AptlyProject = AptlyProjectSchema<string, string>;
 export interface AptlyProjectSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE>, AptlyHistorySchema<ID, DATE> {
     organization: AptlyOrganizationSchema<ID, DATE> | ID;

package/models/unit.d.ts

@@ -12,6 +12,8 @@ import { AptlyUnitTemplateBaseSchema, AptlyUnitTemplateCategorySchema, AptlyUnit
 import { AptlyIntegration, AptlyUnitItemParamKey, AptlyUnitStatus } from '../enums/index.js';
 import { AptlyUserSchema } from './user.js';
 import { AptlyOrganizationSchema } from './organization.js';
+export type AptlyUnitContent = AptlyUnitContentSchema<string, string>;
+export type AptlyUnitContentSchema<ID, DATE> = Pick<AptlyUnitSchema<ID, DATE>, '_id' | 'name' | 'address' | 'shipping' | 'billing'>;
 export type AptlyUnit = AptlyUnitSchema<string, string>;
 export interface AptlyUnitSchema<ID, DATE> extends AptlyUnitTemplateBaseSchema<ID, DATE>, AptlyUnitEditData<DATE>, AptlyHistorySchema<ID, DATE> {
     status: AptlyUnitStatus;

package/package.json

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