@aptly-as/types 1.4.1 → 1.5.0

package/core/permission.d.ts

@@ -1,5 +1,5 @@
 export declare type AptlyPermissionGlobalModels = 'superAdmin' | 'admin' | 'beta' | 'default';
 export declare type AptlyPermissionModules = 'projectBooking' | 'projectSupport' | 'projectRecommendations';
-export declare type AptlyPermissionModulesModels = 'default' | 'core' | 'algorithms' | 'booking' | 'unitExtraOptions' | 'unitExtraFields' | 'pages' | 'recommendations' | 'subcontractor' | 'optionLabels' | 'support' | 'testing';
+export declare type AptlyPermissionModulesModels = 'default' | 'core' | 'algorithms' | 'departments' | 'booking' | 'unitExtraOptions' | 'unitExtraFields' | 'pages' | 'recommendations' | 'subcontractor' | 'optionLabels' | 'support' | 'testing';
 export declare type AptlyPermissionOrganizationModels = 'testingAdmin' | 'admin' | 'content' | 'reports' | 'support' | 'thirdParty' | 'default';
-export declare type AptlyPermissionModels = 'admin' | 'adminBilling' | 'adminProducers' | 'adminProducts' | 'adminReport' | 'adminStats' | 'adminSuppliers' | 'adminTags' | 'adminTesting' | 'adminUsers' | 'adminOrganizations' | 'beta' | 'organization' | 'organizationBooking' | 'organizationClients' | 'organizationMembers' | 'organizationOptionLabels' | 'organizationOrders' | 'organizationProducts' | 'organizationReport' | 'organizationStats' | 'organizationLogo' | 'organizationWebhooks' | 'project' | 'projectAlgorithms' | 'projectBooking' | 'projectDocuments' | 'projectInquiry' | 'projectOrders' | 'projectPages' | 'projectPeriods' | 'projectProducts' | 'projectRecommendations' | 'projectReport' | 'projectReportPrice' | 'projectTheme' | 'projectSigning' | 'projectSubcontractor' | 'projectUnits' | 'projectUnitInvites' | 'projectUnitExtraFields' | 'projectUnitExtraOptions' | 'projectUnitTemplates' | 'projectUnitTemplatesAlgorithms' | 'projectUnitTemplatesPrices' | 'projectUpsellTemplates' | 'unit' | 'unitBooking' | 'unitInquiry' | 'unitOrders' | 'unitPages' | 'unitProducts' | 'unitReport';
+export declare type AptlyPermissionModels = 'admin' | 'adminBilling' | 'adminProducers' | 'adminProducts' | 'adminReport' | 'adminStats' | 'adminSuppliers' | 'adminTags' | 'adminTesting' | 'adminUsers' | 'adminOrganizations' | 'beta' | 'organization' | 'organizationBooking' | 'organizationClients' | 'organizationDepartments' | 'organizationMembers' | 'organizationOptionLabels' | 'organizationOrders' | 'organizationProducts' | 'organizationReport' | 'organizationStats' | 'organizationLogo' | 'organizationWebhooks' | 'project' | 'projectAlgorithms' | 'projectBooking' | 'projectDocuments' | 'projectInquiry' | 'projectOrders' | 'projectPages' | 'projectPeriods' | 'projectProducts' | 'projectRecommendations' | 'projectReport' | 'projectReportPrice' | 'projectTheme' | 'projectSigning' | 'projectSubcontractor' | 'projectUnits' | 'projectUnitInvites' | 'projectUnitExtraFields' | 'projectUnitExtraOptions' | 'projectUnitTemplates' | 'projectUnitTemplatesAlgorithms' | 'projectUnitTemplatesPrices' | 'projectUpsellTemplates' | 'unit' | 'unitBooking' | 'unitInquiry' | 'unitOrders' | 'unitPages' | 'unitProducts' | 'unitReport';

package/core/permission.ts

@@ -7,6 +7,7 @@ export type AptlyPermissionModulesModels =
   | 'default'
   | 'core'
   | 'algorithms'
+  | 'departments'
   | 'booking'
   | 'unitExtraOptions'
   | 'unitExtraFields'
@@ -42,6 +43,7 @@ export type AptlyPermissionModels =
   | 'organization'
   | 'organizationBooking'
   | 'organizationClients'
+  | 'organizationDepartments'
   | 'organizationMembers'
   | 'organizationOptionLabels'
   | 'organizationOrders'

package/models/department.d.ts

@@ -0,0 +1,28 @@
+import { AptlyPermissionOrganizationModels } from '../core';
+import { AptlyOrganizationSchema } from './organization';
+import { AptlyProjectSchema } from './project';
+import { AptlyUserSchema } from './user';
+import { AptlyBaseSchema } from './extends';
+import { AptlyUnitSchema } from './unit';
+export declare type AptlyDepartment = AptlyDepartmentGeneric<string, string>;
+export interface AptlyDepartmentGeneric<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'archived'> {
+    organization: ID | AptlyOrganizationSchema<ID, DATE>;
+    projects: AptlyDepartmentProjectGeneric<ID, DATE>[];
+    users: AptlyDepartmentUserGeneric<ID, DATE>[];
+}
+export declare type AptlyDepartmentProject = AptlyDepartmentProjectGeneric<string, string>;
+export interface AptlyDepartmentProjectGeneric<ID, DATE> {
+    _id: ID;
+    project: (ID | AptlyProjectSchema<ID, DATE>);
+    units: (ID | AptlyUnitSchema<ID, DATE>)[] | null;
+    createdAt: DATE;
+    updatedAt: DATE;
+}
+export declare type AptlyDepartmentUser = AptlyDepartmentUserGeneric<string, string>;
+export interface AptlyDepartmentUserGeneric<ID, DATE> {
+    _id: ID;
+    user: (ID | AptlyUserSchema<ID, DATE>);
+    permissions: AptlyPermissionOrganizationModels[];
+    createdAt: DATE;
+    updatedAt: DATE;
+}

package/models/department.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=department.js.map

package/models/department.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"department.js","sourceRoot":"","sources":["department.ts"],"names":[],"mappings":""}

package/models/department.ts

@@ -0,0 +1,31 @@
+import { AptlyPermissionOrganizationModels } from '../core';
+import { AptlyOrganizationSchema } from './organization';
+import { AptlyProjectSchema } from './project';
+import { AptlyUserSchema } from './user';
+import { AptlyBaseSchema } from './extends';
+import { AptlyUnitSchema } from './unit';
+
+export type AptlyDepartment = AptlyDepartmentGeneric<string, string>;
+export interface AptlyDepartmentGeneric<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'archived'> {
+  organization: ID | AptlyOrganizationSchema<ID, DATE>;
+  projects: AptlyDepartmentProjectGeneric<ID, DATE>[];
+  users: AptlyDepartmentUserGeneric<ID, DATE>[];
+}
+
+export type AptlyDepartmentProject = AptlyDepartmentProjectGeneric<string, string>;
+export interface AptlyDepartmentProjectGeneric<ID, DATE> {
+  _id: ID;
+  project: (ID | AptlyProjectSchema<ID, DATE>);
+  units: (ID | AptlyUnitSchema<ID, DATE>)[] | null;
+  createdAt: DATE;
+  updatedAt: DATE;
+}
+
+export type AptlyDepartmentUser = AptlyDepartmentUserGeneric<string, string>;
+export interface AptlyDepartmentUserGeneric<ID, DATE> {
+  _id: ID;
+  user: (ID | AptlyUserSchema<ID, DATE>);
+  permissions: AptlyPermissionOrganizationModels[];
+  createdAt: DATE;
+  updatedAt: DATE;
+}

package/models/extends.ts

@@ -36,4 +36,4 @@ export interface AptlyHistoryHistorySchema<ID, DATE> {
 export interface AptlyDBCrawlerCleaner {
   dontClean?: boolean;
   lastClean?: boolean;
-}
+}

package/models/index.d.ts

@@ -1,5 +1,6 @@
 export * from './booking';
 export * from './client';
+export * from './department';
 export * from './document';
 export * from './extends';
 export * from './inquiry';

package/models/index.js

@@ -5,6 +5,7 @@ function __export(m) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __export(require("./booking"));
 __export(require("./client"));
+__export(require("./department"));
 __export(require("./document"));
 __export(require("./extends"));
 __export(require("./inquiry"));

package/models/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;AACA,+BAA0B;AAC1B,8BAAyB;AACzB,gCAA2B;AAC3B,+BAA0B;AAC1B,+BAA0B;AAC1B,6BAAwB;AACxB,4CAAuC;AACvC,oCAA+B;AAC/B,6BAAwB;AACxB,oCAA+B;AAC/B,4BAAuB;AACvB,gCAA2B;AAC3B,+BAA0B;AAC1B,qCAAgC;AAChC,+BAA0B;AAC1B,sCAAiC;AACjC,sCAAiC;AACjC,gCAA2B;AAC3B,2BAAsB;AACtB,4BAAuB;AACvB,qCAAgC;AAChC,kCAA6B;AAC7B,uCAAkC;AAClC,4BAAuB;AACvB,+BAA0B;AAC1B,qCAAgC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;AACA,+BAA0B;AAC1B,8BAAyB;AACzB,kCAA6B;AAC7B,gCAA2B;AAC3B,+BAA0B;AAC1B,+BAA0B;AAC1B,6BAAwB;AACxB,4CAAuC;AACvC,oCAA+B;AAC/B,6BAAwB;AACxB,oCAA+B;AAC/B,4BAAuB;AACvB,gCAA2B;AAC3B,+BAA0B;AAC1B,qCAAgC;AAChC,+BAA0B;AAC1B,sCAAiC;AACjC,sCAAiC;AACjC,gCAA2B;AAC3B,2BAAsB;AACtB,4BAAuB;AACvB,qCAAgC;AAChC,kCAA6B;AAC7B,uCAAkC;AAClC,4BAAuB;AACvB,+BAA0B;AAC1B,qCAAgC"}

package/models/index.ts

@@ -1,6 +1,7 @@
 
 export * from './booking';
 export * from './client';
+export * from './department';
 export * from './document';
 export * from './extends';
 export * from './inquiry';

package/models/organization.d.ts

@@ -3,6 +3,8 @@ import { AptlySignageSchema } from '../core/signage';
 import { AptlyUserSchema } from './user';
 import { AptlyMediaSrc } from './media';
 import { AptlyBaseSchema } from './extends';
+import { AptlyDepartmentGeneric } from './department';
+import { AptlyProducerSchema } from './producer';
 export declare type AptlyOrganization = AptlyOrganizationSchema<string, string>;
 export interface AptlyOrganizationSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
     slug: string;
@@ -26,6 +28,7 @@ export interface AptlyOrganizationSchema<ID, DATE> extends AptlyBaseSchema<ID, D
     modules: AptlyPermissionModulesModels[];
     contractSign?: AptlySignageSchema<ID, DATE>;
     integrations: AptlyOrganizationIntegrationsSchema<ID>[];
+    invites: AptlyOrganizationInviteSchema<ID, DATE>[];
     /**
      * @deprecated use createdAt
      */
@@ -43,4 +46,21 @@ export interface AptlyOrganizationMemberSchema<ID, DATE> {
     _id: ID;
     user: AptlyUserSchema<ID, DATE> | ID;
     permissions: AptlyPermissionOrganizationModels[];
+    projects?: (ID | AptlyProducerSchema<ID, DATE>)[] | null;
+    departments?: (ID | AptlyDepartmentGeneric<ID, DATE>)[];
+}
+export declare type AptlyOrganizationInvite = AptlyOrganizationInviteSchema<string, string>;
+export interface AptlyOrganizationInviteSchema<ID, DATE> {
+    _id: ID;
+    code: string;
+    created: DATE;
+    permissions?: AptlyPermissionOrganizationModels[];
+    projects?: ID[] | null;
+    departments?: ID[] | null;
+    claim: {
+        email?: string;
+        claimed: boolean;
+        claimedBy: ID;
+        claimTime?: DATE;
+    };
 }

package/models/organization.ts

@@ -3,6 +3,8 @@ import { AptlySignageSchema } from '../core/signage';
 import { AptlyUserSchema } from './user';
 import { AptlyMediaSrc } from './media';
 import { AptlyBaseSchema } from './extends';
+import { AptlyDepartmentGeneric } from './department';
+import { AptlyProducerSchema } from './producer';
 
 export type AptlyOrganization = AptlyOrganizationSchema<string, string>;
 export interface AptlyOrganizationSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
@@ -27,6 +29,7 @@ export interface AptlyOrganizationSchema<ID, DATE> extends AptlyBaseSchema<ID, D
   modules: AptlyPermissionModulesModels[];
   contractSign?: AptlySignageSchema<ID, DATE>;
   integrations: AptlyOrganizationIntegrationsSchema<ID>[];
+  invites: AptlyOrganizationInviteSchema<ID, DATE>[];
 
   /**
    * @deprecated use createdAt
@@ -47,4 +50,22 @@ export interface AptlyOrganizationMemberSchema<ID, DATE> {
   _id: ID;
   user: AptlyUserSchema<ID, DATE> | ID;
   permissions: AptlyPermissionOrganizationModels[];
+  projects?: (ID | AptlyProducerSchema<ID, DATE>)[] | null;
+  departments?: (ID | AptlyDepartmentGeneric<ID, DATE>)[];
+}
+
+export type AptlyOrganizationInvite = AptlyOrganizationInviteSchema<string, string>;
+export interface AptlyOrganizationInviteSchema<ID, DATE> {
+  _id: ID;
+  code: string;
+  created: DATE;
+  permissions?: AptlyPermissionOrganizationModels[];
+  projects?: ID[] | null;
+  departments?: ID[] | null;
+  claim: {
+    email?: string;
+    claimed: boolean;
+    claimedBy: ID;
+    claimTime?: DATE;
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptly-as/types",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "Aptly types and enums",
   "main": "./index.js",
   "types": "./index.d.ts",