@managemint-solutions/entities 1.36.0 → 1.46.0

package/dist/paystack/index.d.ts

@@ -1,3 +1,4 @@
+import type { PaystackDocumentChargeMetadata, PaystackOwnChargeMetadata } from './webhook';
 export type PaystackReturn<T = any> = {
     status: false;
     message: string;
@@ -111,15 +112,13 @@ export type PaystackTransactionInitialize = {
     callback_url?: string;
     plan?: string;
     invoice_limit?: number;
-    metadata: {
-        organization_id: string;
-        idempotencyKey: string;
-        transactionId: string;
-    };
+    metadata: PaystackOwnChargeMetadata | PaystackDocumentChargeMetadata;
     split_code?: string;
+    /** The subaccount the charge settles to (`ACCT_...`). */
     subaccount?: string;
     transaction_charge?: number;
-    bearer?: string;
+    /** Who pays Paystack's fee: `account` (the platform, the default) or `subaccount`. */
+    bearer?: 'account' | 'subaccount';
 };
 export type PaystackTransactionInitializeResponse = {
     authorization_url: string;
@@ -162,3 +161,61 @@ export type PaystackChargeAuthorizationResponse = {
         reusable: boolean;
     };
 };
+/** One bank from `GET /bank?currency=ZAR` - the fields the payouts form uses. */
+export type PaystackBank = {
+    id: number;
+    name: string;
+    /** The branch code Paystack names the bank by (`250655`). */
+    code: string;
+    active: boolean;
+    is_deleted: boolean;
+    currency: string;
+};
+/**
+ * `POST /bank/validate`: South Africa's account check against the holder's identity document
+ * (there is no account-name lookup there).
+ */
+export type PaystackBankValidate = {
+    bank_code: string;
+    country_code: 'ZA';
+    account_number: string;
+    account_name: string;
+    account_type: string;
+    document_type: string;
+    document_number: string;
+};
+export type PaystackBankValidateResponse = {
+    /** The answer that matters; the flags below are its parts. Always false in test mode. */
+    verified: boolean;
+    verificationMessage: string;
+    accountAcceptsCredits: boolean;
+    accountAcceptsDebits: boolean;
+    accountHolderMatch: boolean;
+    accountOpenForMoreThanThreeMonths: boolean;
+};
+/**
+ * `POST /subaccount`. The API reads the bank code as `settlement_bank`, as the docs' own sample
+ * does, not the `bank_code` their parameter list names.
+ */
+export type PaystackSubaccountCreate = {
+    business_name: string;
+    settlement_bank: string;
+    account_number: string;
+    /** The platform's share of each payment, in percent. */
+    percentage_charge: number;
+};
+/** `PUT /subaccount/:code`; `active: false` switches it off. */
+export type PaystackSubaccountUpdate = Partial<PaystackSubaccountCreate> & {
+    active?: boolean;
+};
+export type PaystackSubaccountResponse = {
+    id: number;
+    subaccount_code: string;
+    business_name: string;
+    /** The bank's name, though the request sent its code. */
+    settlement_bank: string;
+    account_number: string;
+    percentage_charge: number;
+    currency: string;
+    active: boolean;
+};

package/dist/paystack/webhook/index.d.ts

@@ -1,4 +1,4 @@
-import { PaystackWebhookEvent } from '../enum';
+import { PaystackChargeKind, PaystackWebhookEvent } from '../enum';
 export type PaystackAuthorization = {
     authorization_code: string;
     bin: number;
@@ -248,6 +248,12 @@ export type PaystackOwnChargeMetadata = {
     idempotencyKey: string;
     transactionId: string;
 };
+/** The metadata block on a document's Pay now checkout. */
+export type PaystackDocumentChargeMetadata = {
+    kind: PaystackChargeKind.DOCUMENT_PAYMENT;
+    document_id: string;
+    organization_id: string;
+};
 /** The metadata block Paystack's own hosted pages attach, e.g. the card-update page. */
 export type PaystackHostedPageChargeMetadata = {
     /** 'update_card' on the card-update page's tokenising charge. */
@@ -282,8 +288,9 @@ export type PaystackTransactionSuccessfulEvent = {
          * - Absent or empty: not ours. A subscription renewal is recognised by `plan`
          *   naming the organization's plan code, never by the missing metadata alone;
          *   anything else is recorded as unclassified.
+         * - `kind: 'document_payment'`: a document's Pay now checkout.
          */
-        metadata?: PaystackOwnChargeMetadata | PaystackHostedPageChargeMetadata;
+        metadata?: PaystackOwnChargeMetadata | PaystackHostedPageChargeMetadata | PaystackDocumentChargeMetadata;
         log: {
             time_spent: number;
             attempts: number;

package/dist/projects/index.d.ts

@@ -44,4 +44,6 @@ export type ProjectEntity = {
     deleted_by: UserIdentity | null;
     restored_at: Date | null;
     restored_by: UserIdentity | null;
+    /** Present on staff reads only. */
+    organization?: OrganizationIdentity;
 };

package/dist/tasks/index.d.ts

@@ -69,4 +69,6 @@ export type TaskEntity = {
     deleted_by: UserIdentity | null;
     restored_at: Date | null;
     restored_by: UserIdentity | null;
+    /** Present on staff reads only. */
+    organization?: OrganizationIdentity;
 };

package/dist/users/index.d.ts

@@ -149,6 +149,7 @@ export interface Permissions {
         projects: CrudPermission;
         project_budgets: CrudPermission;
         tasks: CrudPermission;
+        documents: CrudPermission;
         timesheets: CrudPermission;
         invoices: Omit<CrudPermission, 'create' | 'update' | 'delete'>;
         leave_types: CrudPermission;

package/dist/users/permissions/dto/index.d.ts

@@ -19,6 +19,10 @@ export type UpdatePermissionsDto = {
     read_timesheets: boolean;
     update_timesheets: boolean;
     delete_timesheets: boolean;
+    create_documents: boolean;
+    read_documents: boolean;
+    update_documents: boolean;
+    delete_documents: boolean;
     create_leave: boolean;
     read_leave: boolean;
     update_leave: boolean;

package/dist/visibility/dto/index.d.ts

@@ -0,0 +1,13 @@
+import type { DocumentVisibility } from '../../documents/enum';
+import type { VisibilityRole } from '../enum';
+/**
+ * Replaces a record's setting and its whole share list. The creator is never in the list - they
+ * are always an admin - and everyone in it belongs to the organization.
+ */
+export type UpdateVisibilityDto = {
+    visibility: DocumentVisibility;
+    shares: {
+        user_id: string;
+        role: VisibilityRole;
+    }[];
+};

package/dist/visibility/dto/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/visibility/enum/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The kinds of record a private share can be on. Each value is the record's own table, and the
+ * key a `visibility` row is filed under; a new kind is a member here and a policy on its table.
+ */
+export declare enum VisibilityEntityType {
+    DOCUMENT_TEMPLATES = "document_templates",
+    DOCUMENTS = "documents"
+}
+/** What a person may do with a private record shared with them. Its creator is always ADMIN. */
+export declare enum VisibilityRole {
+    /** View and print. */
+    READ = "read",
+    /** Read, and edit (a document only while it is a draft). */
+    WRITE = "write",
+    /** Write, and issue, void, delete and manage who it is shared with. */
+    ADMIN = "admin"
+}

package/dist/visibility/enum/index.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VisibilityRole = exports.VisibilityEntityType = void 0;
+/**
+ * The kinds of record a private share can be on. Each value is the record's own table, and the
+ * key a `visibility` row is filed under; a new kind is a member here and a policy on its table.
+ */
+var VisibilityEntityType;
+(function (VisibilityEntityType) {
+    VisibilityEntityType["DOCUMENT_TEMPLATES"] = "document_templates";
+    VisibilityEntityType["DOCUMENTS"] = "documents";
+})(VisibilityEntityType || (exports.VisibilityEntityType = VisibilityEntityType = {}));
+/** What a person may do with a private record shared with them. Its creator is always ADMIN. */
+var VisibilityRole;
+(function (VisibilityRole) {
+    /** View and print. */
+    VisibilityRole["READ"] = "read";
+    /** Read, and edit (a document only while it is a draft). */
+    VisibilityRole["WRITE"] = "write";
+    /** Write, and issue, void, delete and manage who it is shared with. */
+    VisibilityRole["ADMIN"] = "admin";
+})(VisibilityRole || (exports.VisibilityRole = VisibilityRole = {}));

package/dist/visibility/index.d.ts

@@ -0,0 +1,13 @@
+import type { DocumentVisibility } from '../documents/enum';
+import type { UserIdentity } from '../users';
+import type { VisibilityRole } from './enum';
+/** One person a private record is shared with. */
+export type VisibilityShare = {
+    user: UserIdentity;
+    role: VisibilityRole;
+};
+/** Who can see a record: its setting and, when private, the people it is shared with. */
+export type RecordVisibility = {
+    visibility: DocumentVisibility;
+    shares: VisibilityShare[];
+};

package/dist/visibility/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@managemint-solutions/entities",
-  "version": "1.36.0",
+  "version": "1.46.0",
   "description": "Entity types used by both the api and portal",
   "homepage": "https://github.com/ManageMint-Solutions/managemint-solutions-entities#readme",
   "bugs": {