@fabriktor/fx 0.0.124 → 0.0.126

package/dist/src/payrolls/workspace.d.ts

@@ -1,5 +1,5 @@
-import type { BillableOperator, PayrollsOperator, QueryOptions } from "@fabriktor/client";
-import { ColPayrollsPayrolls, ColPayrollsHourBanks, ColPayrollsPayables, ColPayrollsAdjustments, ColPayrollsAdjustmentFolders, ColPayrollsPayConfigs, ColPayrollsEmployeePayConfigs, ColPayrollsAdjustmentRecords, ColPayrollsAdjustmentAggregates, ColPayrollsPayrollPrograms, type Payroll, type HourBank, type Payable, type Adjustment, type AdjustmentFolder, type PayConfig, type EmployeePayConfig, type AdjustmentRecord, type AdjustmentAggregate, type PayrollProgram, type InPayroll, type InAdjustment, type InAdjustmentFolder, type InPayConfig, type InEmployeePayConfig, type InPayrollProgram, type InAdjustmentAggregate, type PLPayrollsGeneratePayrollFromEntities, type InDate, type Period } from "@fabriktor/schema";
+import type { FieldOf, BillableOperator, PayrollsOperator, QueryOptions } from "@fabriktor/client";
+import { ColPayrollsPayrolls, ColPayrollsHourBanks, ColPayrollsPayables, ColPayrollsAdjustments, ColPayrollsAdjustmentFolders, ColPayrollsPayConfigs, ColPayrollsEmployeePayConfigs, ColPayrollsAdjustmentRecords, ColPayrollsAdjustmentAggregates, ColPayrollsPayrollPrograms, type Payroll, type HourBank, type Payable, type Adjustment, type AdjustmentFolder, type PayConfig, type EmployeePayConfig, type AdjustmentRecord, type AdjustmentAggregate, type PayrollProgram, type InPayroll, type InAdjustment, type InAdjustmentFolder, type InPayConfig, type InEmployeePayConfig, type InPayrollProgram, type InAdjustmentAggregate, type PLPayrollsGeneratePayrollFromEntities, type InDate, type Period, type Folder } from "@fabriktor/schema";
 import type { EmploymentActor, EmploymentReadContext } from "../contacts/scope.js";
 import { type SearchOptions, type SearchPage } from "../core/search.js";
 import type { MultiCreateAttempt } from "../core/multi-create.js";
@@ -49,98 +49,19 @@ export type PayrollFilters = {
     type?: string[];
     name?: string[];
 };
-export declare const payrollPolicies: {
-    payrolls: {
-        create: true;
-        remove: true;
-        report: true;
-        filters: ("timezone" | "currency" | "employee_id" | "employee_pay_config_id" | "hour_bank_id" | "period_indexes" | "is_banked" | "is_problematic")[];
-        employee_read: boolean;
-        searchable: boolean;
-        archive: boolean;
-    };
-    hour_banks: {
-        searchable: false;
-        filters: ("timezone" | "currency" | "employee_id" | "period_indexes" | "is_payrolled")[];
-        employee_read: boolean;
-        create: boolean;
-        archive: boolean;
-        remove: boolean;
-        report: boolean;
-    };
-    payables: {
-        filters: ("period_index" | "currency" | "employee_id" | "payroll_id" | "is_payrolled")[];
-        employee_read: boolean;
-        searchable: boolean;
-        create: boolean;
-        archive: boolean;
-        remove: boolean;
-        report: boolean;
-    };
-    adjustments: {
-        filters: ("is_archived" | "type" | "currency" | "folder_id" | "name" | "is_employer_contribution")[];
-        employee_read: boolean;
-        searchable: boolean;
-        create: boolean;
-        archive: boolean;
-        remove: boolean;
-        report: boolean;
-    };
-    adjustment_folders: {
-        filters: "is_archived"[];
-        employee_read: boolean;
-        searchable: boolean;
-        create: boolean;
-        archive: boolean;
-        remove: boolean;
-        report: boolean;
-    };
-    pay_configs: {
-        filters: ("is_archived" | "type" | "currency" | "name")[];
-        employee_read: boolean;
-        searchable: boolean;
-        create: boolean;
-        archive: boolean;
-        remove: boolean;
-        report: boolean;
-    };
-    employee_pay_configs: {
-        employee_read: true;
-        filters: ("is_archived" | "currency" | "name" | "employee_id" | "pay_config_id")[];
-        searchable: boolean;
-        create: boolean;
-        archive: boolean;
-        remove: boolean;
-        report: boolean;
-    };
-    adjustment_records: {
-        filters: ("period_index" | "currency" | "employee_id" | "payroll_id")[];
-        employee_read: boolean;
-        searchable: boolean;
-        create: boolean;
-        archive: boolean;
-        remove: boolean;
-        report: boolean;
-    };
-    adjustment_aggregates: {
-        employee_read: false;
-        create: true;
-        report: true;
-        filters: ("currency" | "period_indexes")[];
-        searchable: boolean;
-        archive: boolean;
-        remove: boolean;
-    };
-    payroll_programs: {
-        searchable: false;
-        create: true;
-        remove: true;
-        filters: ("timezone" | "currency" | "employee_id" | "employee_pay_config_id" | "is_enabled")[];
-        employee_read: boolean;
-        archive: boolean;
-        report: boolean;
-    };
+type Policy<K extends PayrollResource> = {
+    employee_read: boolean;
+    searchable: boolean;
+    create: boolean;
+    archive: boolean;
+    remove: boolean;
+    report: boolean;
+    filters: readonly (keyof PayrollFilters & FieldOf<PayrollRecordMap[K]>)[];
 };
+type PayrollPolicies = {
+    [K in PayrollResource]: Policy<K>;
+};
+export declare const payrollPolicies: PayrollPolicies;
 export declare const payrollPayTypes: readonly ["per_hour", "fixed"];
 export declare const payrollAdjustmentTypes: readonly ["rate", "per_period", "per_hour"];
 export declare const payrollRecurrenceTypes: readonly ["daily", "weekly", "monthly", "yearly"];
@@ -182,7 +103,7 @@ export declare class PayrollWorkflowError extends Error {
 }
 export declare function payrollCanManage(actor: EmploymentActor, record?: PayrollRecord | null): boolean;
 export declare function payrollCanRead(actor: EmploymentActor, resource: PayrollResource): boolean;
-export declare function payrollFilterQuery(resource: PayrollResource, filters?: PayrollFilters): QueryOptions;
+export declare function payrollFilterQuery<K extends PayrollResource>(resource: K, filters?: PayrollFilters, employee_id?: string): QueryOptions;
 export declare class PayrollsWorkspace {
     private readonly payrolls;
     private readonly billable?;
@@ -204,7 +125,9 @@ export declare class PayrollsWorkspace {
     private adjustments;
     private config;
     private validateCommand;
+    updateFolder(actor: EmploymentActor, id: string, input: Folder): Promise<AdjustmentFolder>;
     setArchived(actor: EmploymentActor, resource: PayrollResource, record: PayrollRecord, value: boolean): Promise<void>;
     setEnabled(actor: EmploymentActor, record: PayrollProgram, is_enabled: boolean): Promise<void>;
     remove(actor: EmploymentActor, resource: PayrollResource, record: PayrollRecord): Promise<void>;
 }
+export {};

package/dist/src/payrolls/workspace.js

@@ -1,4 +1,4 @@
-import { isHTTPClientErr } from "@fabriktor/client";
+import { isHTTPClientErr, queryParam } from "@fabriktor/client";
 import { ColPayrollsPayrolls, ColPayrollsHourBanks, ColPayrollsPayables, ColPayrollsAdjustments, ColPayrollsAdjustmentFolders, ColPayrollsPayConfigs, ColPayrollsEmployeePayConfigs, ColPayrollsAdjustmentRecords, ColPayrollsAdjustmentAggregates, ColPayrollsPayrollPrograms, UserTypeEmployer, UserTypeEmployee, AdjustmentTypeRate, AdjustmentTypePerHour, AdjustmentTypePerPeriod, PayTypeFixed, PayTypePerHour, RecurrenceTypeDaily, RecurrenceTypeWeekly, RecurrenceTypeMonthly, RecurrenceTypeYearly, } from "@fabriktor/schema";
 import { employmentCanRead, employmentCatalogOwnerIDs, employmentOwnsRecord, } from "../contacts/scope.js";
 import { normalizeIDs, requiredOperationID } from "../core/id.js";
@@ -23,7 +23,6 @@ const generated = {
     archive: false,
     remove: false,
     report: false,
-    filters: [],
 };
 const catalog = {
     ...generated,
@@ -31,7 +30,7 @@ const catalog = {
     create: true,
     archive: true,
 };
-// The service README and record Rules() define this capability/filter table.
+// Service routes, record behavior and Rules() define this capability/filter table.
 // A generic CRUD method in the client is not permission to edit an immutable record.
 export const payrollPolicies = {
     [PayrollResource.Payrolls]: {
@@ -82,7 +81,12 @@ export const payrollPolicies = {
             "is_archived",
         ],
     },
-    [PayrollResource.Folders]: { ...catalog, filters: ["is_archived"] },
+    [PayrollResource.Folders]: {
+        ...catalog,
+        archive: false,
+        remove: true,
+        filters: ["is_archived"],
+    },
     [PayrollResource.PayConfigs]: {
         ...catalog,
         filters: ["type", "name", "currency", "is_archived"],
@@ -162,9 +166,18 @@ export function payrollCanRead(actor, resource) {
         (actor.active_mode === UserTypeEmployer ||
             payrollPolicies[resource].employee_read));
 }
-export function payrollFilterQuery(resource, filters = {}) {
-    const allowed = payrollPolicies[resource].filters;
-    return Object.fromEntries(Object.entries(filters).filter(([key, value]) => allowed.includes(key) && value !== undefined));
+export function payrollFilterQuery(resource, filters = {}, employee_id) {
+    const policy = payrollPolicies[resource];
+    const query = {};
+    for (const key of policy.filters) {
+        // Authenticated employee scope takes precedence over selectable filters.
+        const value = key === "employee_id" && employee_id !== undefined
+            ? employee_id
+            : filters[key];
+        if (value !== undefined)
+            Object.assign(query, queryParam(key, value));
+    }
+    return query;
 }
 export class PayrollsWorkspace {
     payrolls;
@@ -234,9 +247,9 @@ export class PayrollsWorkspace {
         if (!payrollCanRead(opts.context, opts.resource))
             return emptySearchPage(opts.page, opts.per_page);
         const owner_ids = employmentCatalogOwnerIDs(opts.context, opts.employer_ids);
-        const query = payrollFilterQuery(opts.resource, opts.filters);
-        if (opts.context.active_mode === UserTypeEmployee)
-            query.employee_id = opts.context.owner_id;
+        const query = payrollFilterQuery(opts.resource, opts.filters, opts.context.active_mode === UserTypeEmployee
+            ? opts.context.owner_id
+            : undefined);
         const port = this.ports[opts.resource];
         if (payrollPolicies[opts.resource].searchable) {
             return runOwnerScopeSearch({
@@ -483,6 +496,19 @@ export class PayrollsWorkspace {
                 break;
         }
     }
+    async updateFolder(actor, id, input) {
+        await this.owned(actor, PayrollResource.Folders, id);
+        const folder_name = input.folder_name.trim();
+        requirePayroll(folder_name, "invalid");
+        await this.payrolls.replaceOneAdjustmentFolder({
+            id,
+            in: {
+                folder_name,
+                folder_description: input.folder_description.trim(),
+            },
+        });
+        return this.owned(actor, PayrollResource.Folders, id);
+    }
     async setArchived(actor, resource, record, value) {
         requirePayroll(payrollCanManage(actor, record) && payrollPolicies[resource].archive, "access");
         await this.owned(actor, resource, record.id);
@@ -491,9 +517,6 @@ export class PayrollsWorkspace {
             case PayrollResource.Adjustments:
                 await this.payrolls.replaceOneAdjustment(opts);
                 break;
-            case PayrollResource.Folders:
-                await this.payrolls.replaceOneAdjustmentFolder(opts);
-                break;
             case PayrollResource.PayConfigs:
                 await this.payrolls.replaceOnePayConfig(opts);
                 break;
@@ -518,5 +541,7 @@ export class PayrollsWorkspace {
             await this.payrolls.deleteOnePayroll({ id: record.id });
         else if (resource === PayrollResource.Programs)
             await this.payrolls.deleteOnePayrollProgram({ id: record.id });
+        else if (resource === PayrollResource.Folders)
+            await this.payrolls.deleteOneAdjustmentFolder({ id: record.id });
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fabriktor/fx",
-  "version": "0.0.124",
+  "version": "0.0.126",
   "description": "![Fabriktor Logo](./img/fabriktor-character.gif)",
   "type": "module",
   "exports": {