@aptly-as/types - npm Package Compare versions

Comparing version 2.1.10 to 2.2.0

core/scope.d.ts

@@ -13,2 +13,3 @@ export declare enum AptlyModules {
     ThirdParty = "thirdParty",
+    Sign = "sign",
     Support = "support",
@@ -74,2 +75,3 @@ SupportComplaint = "supportComplaint",
     ProjectUnitExtraOptions = "projectUnitExtraOptions",
+    ProjectUnitDocuments = "projectUnitDocuments",
     ProjectUnitTemplates = "projectUnitTemplates",
@@ -76,0 +78,0 @@ ProjectUnitTemplatesAlgorithms = "projectUnitTemplatesAlgorithms",

core/scope.js

@@ -14,2 +14,3 @@ export var AptlyModules;
     AptlyModules["ThirdParty"] = "thirdParty";
+    AptlyModules["Sign"] = "sign";
     AptlyModules["Support"] = "support";
@@ -76,2 +77,3 @@ AptlyModules["SupportComplaint"] = "supportComplaint";
     AptlyScopes["ProjectUnitExtraOptions"] = "projectUnitExtraOptions";
+    AptlyScopes["ProjectUnitDocuments"] = "projectUnitDocuments";
     AptlyScopes["ProjectUnitTemplates"] = "projectUnitTemplates";
@@ -78,0 +80,0 @@ AptlyScopes["ProjectUnitTemplatesAlgorithms"] = "projectUnitTemplatesAlgorithms";

enums/index.d.ts

@@ -6,2 +6,3 @@ export * from './document.js';
 export declare enum AptlyOrderStatus {
+    New = "new",
     NotSigned = "notSigned",
@@ -13,2 +14,3 @@ ReadyToSign = "readyToSign",
     FileReceived = "fileReceived",
+    Completed = "completed",
     AllPeriodsSigned = "allPeriodsSigned",
@@ -15,0 +17,0 @@ Invalid = "invalid"

enums/index.js

@@ -7,2 +7,3 @@ export * from './document.js';
 (function (AptlyOrderStatus) {
+    AptlyOrderStatus["New"] = "new";
     AptlyOrderStatus["NotSigned"] = "notSigned";
@@ -14,2 +15,3 @@ AptlyOrderStatus["ReadyToSign"] = "readyToSign";
     AptlyOrderStatus["FileReceived"] = "fileReceived";
+    AptlyOrderStatus["Completed"] = "completed";
     AptlyOrderStatus["AllPeriodsSigned"] = "allPeriodsSigned";
@@ -16,0 +18,0 @@ AptlyOrderStatus["Invalid"] = "invalid";

models/app.d.ts

@@ -17,5 +17,15 @@ import { AptlyBaseSchema } from './extends.js';
     webhooks: AptlyAppWebhookSchema<ID>[];
-    proxies: AptlyAppProxySchema<ID>[];
     menus: AptlyAppMenuSchema<ID, DATE>[];
+    implements: AptlyAppImplementation[];
+    sign?: {
+        costPer?: number;
+        order: string;
+    };
 }
+export declare enum AptlyAppImplementation {
+    Sign = "sign"
+}
+export declare enum AptlyAppImplementationSetting {
+    SignCostPer = "costPerSign"
+}
 export type AptlyAppSetting = AptlyAppSettingSchema<string>;
@@ -71,6 +81,1 @@ export interface AptlyAppSettingSchema<ID> extends AptlyField {
 }
-export interface AptlyAppProxySchema<ID> {
-    _id: ID;
-    path: string;
-    url: string;
-}

models/app.js

@@ -0,1 +1,9 @@
+export var AptlyAppImplementation;
+(function (AptlyAppImplementation) {
+    AptlyAppImplementation["Sign"] = "sign";
+})(AptlyAppImplementation || (AptlyAppImplementation = {}));
+export var AptlyAppImplementationSetting;
+(function (AptlyAppImplementationSetting) {
+    AptlyAppImplementationSetting["SignCostPer"] = "costPerSign";
+})(AptlyAppImplementationSetting || (AptlyAppImplementationSetting = {}));
 export var AptlyOrganizationInjection;
@@ -2,0 +10,0 @@ (function (AptlyOrganizationInjection) {

models/order.d.ts

 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 { AptlyUnitItemParamSchema, AptlyUnitSchema } from './unit.js';
+import { AptlyUnit, AptlyUnitItemParamSchema, AptlyUnitSchema } from './unit.js';
 import { AptlyBaseSchema } from './extends.js';
-import { AptlyUserSchema } from './user.js';
+import { AptlyUser, AptlyUserSchema } from './user.js';
 export type AptlyOrder = AptlyOrderSchema<string, string>;
@@ -16,3 +18,4 @@ export interface AptlyOrderSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
     status: AptlyOrderStatus;
-    receipt: ID;
+    receipt: ID | AptlyDocumentSchema<ID, DATE>;
+    signedReceipt?: ID;
     attachments: ID[];
@@ -23,4 +26,17 @@ signage: AptlyOrderSignageSchema<ID, DATE>;
     pricePipeline: AptlyOrderPricePipelineItemSchema<ID>[];
+    signees: AptlyOrderSigneeSchema<ID, DATE>[];
     created: DATE;
 }
+export type AptlyOrderSignee = AptlyOrderSigneeSchema<string, string>;
+export interface AptlyOrderSigneeSchema<ID, DATE> {
+    _id: ID;
+    user: ID;
+    type: AptlyOrderSigneeType;
+    url: string;
+    signedAt?: DATE;
+}
+export declare enum AptlyOrderSigneeType {
+    Unit = 0,
+    Admin = 1
+}
 export type AptlyOrderPricePipelineItem = AptlyOrderPricePipelineItemSchema<string>;
@@ -37,3 +53,3 @@ export interface AptlyOrderPricePipelineItemSchema<ID> {
     documentId?: ID;
-    signedFile?: ID;
+    signedFile?: ID | AptlyDocumentSchema<ID, DATE>;
     documentCreationDate?: DATE;
@@ -64,1 +80,20 @@ expireDate?: DATE;
 }
+export declare enum AptlyOrderAction {
+    Complete = "complete",
+    SignManually = "sign-manually",
+    Sign = "sign"
+}
+export type AptlyOrderActionItem = AptlyOrderActionItemSchema<string, string>;
+export interface AptlyOrderActionItemSchema<ID, DATE> {
+    action: AptlyOrderAction;
+    path: string;
+    app?: Pick<AptlyAppSchema<ID, DATE>, '_id' | 'name' | 'sign'>;
+    costPerSign?: number;
+}
+export interface AptlyOrderActionSignData {
+    project: string;
+    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'>[];
+}

models/order.js

@@ -1,1 +0,11 @@
-export {};
+export var AptlyOrderSigneeType;
+(function (AptlyOrderSigneeType) {
+    AptlyOrderSigneeType[AptlyOrderSigneeType["Unit"] = 0] = "Unit";
+    AptlyOrderSigneeType[AptlyOrderSigneeType["Admin"] = 1] = "Admin";
+})(AptlyOrderSigneeType || (AptlyOrderSigneeType = {}));
+export var AptlyOrderAction;
+(function (AptlyOrderAction) {
+    AptlyOrderAction["Complete"] = "complete";
+    AptlyOrderAction["SignManually"] = "sign-manually";
+    AptlyOrderAction["Sign"] = "sign";
+})(AptlyOrderAction || (AptlyOrderAction = {}));

models/organization.d.ts

@@ -14,2 +14,3 @@ import { AptlyModules } from '../core/index.js';
     slug: string;
+    number?: string;
     logo?: string | null;
@@ -16,0 +17,0 @@ logoMedia?: AptlyMediaSrc | null;

models/unit.d.ts

@@ -0,1 +1,2 @@
+import { AptlyOrderSchema } from './order.js';
 import { AptlyProducerSchema } from './producer.js';
@@ -33,3 +34,3 @@ import { AptlyProductSchema } from './product.js';
     unitTemplate: ID | AptlyUnitTemplateSchema<ID, DATE>;
-    confirmedPeriods: AptlyUnitConfirmedPeriodSchema<ID>[];
+    confirmedPeriods: AptlyUnitConfirmedPeriodSchema<ID, DATE>[];
     queueInvites: string[];
@@ -173,7 +174,7 @@ invites: AptlyUnitInviteSchema<ID, DATE>[];
 }
-export type AptlyUnitConfirmedPeriod = AptlyUnitConfirmedPeriodSchema<string>;
-export interface AptlyUnitConfirmedPeriodSchema<ID> {
+export type AptlyUnitConfirmedPeriod = AptlyUnitConfirmedPeriodSchema<string, string>;
+export interface AptlyUnitConfirmedPeriodSchema<ID, DATE> {
     _id: ID;
     period: ID;
-    order: ID;
+    order?: ID | AptlyOrderSchema<ID, DATE>;
 }
@@ -180,0 +181,0 @@ export type AptlyUnitIntegration = AptlyUnitIntegrationSchema<string>;

package.json

 {
   "name": "@aptly-as/types",
-  "version": "2.1.10",
+  "version": "2.2.0",
   "description": "Aptly types and enums",
@@ -5,0 +5,0 @@ "type": "module",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

101155

increased by2.89%

Lines of code

2640

increased by2.64%

No dependency changes