@fabriktor/fx 0.0.67 → 0.0.68

package/dist/src/privacy/privacy.d.ts

@@ -1,4 +1,4 @@
-import type { PrivacyOperator } from "@fabriktor/client";
+import { type PrivacyExport, type PrivacyOperator } from "@fabriktor/client";
 import { type AccountLock, type DeletionRequest } from "@fabriktor/schema";
 type DeletionRequestInsertOptions = Parameters<PrivacyOperator["insertOneDeletionRequest"]>[0];
 type DeletionRequestReplaceOptions = Parameters<PrivacyOperator["replaceOneDeletionRequest"]>[0];
@@ -11,8 +11,17 @@ export type ReplaceAccountLockOptions = AccountLockReplaceOptions;
 export type PrivacyFXOptions = {
     privacy: PrivacyOperator;
 };
-export type WatchAccountLockOptions = {
+export type GetAccountLockOptions = {
     owner_id: string;
+};
+export type RequestAccountDeletionOptions = CreateDeletionRequestOptions & {
+    owner_id: string;
+};
+export type AccountDeletion = {
+    request: DeletionRequest;
+    lock: AccountLock;
+};
+export type WatchAccountLockOptions = GetAccountLockOptions & {
     on_lock: (lock: AccountLock) => void;
     on_error?: (err: unknown) => void;
 };
@@ -20,18 +29,25 @@ export type StopAccountLockWatch = () => void;
 export interface PrivacyFXOperator {
     createDeletionRequest(opts: CreateDeletionRequestOptions): Promise<DeletionRequest>;
     replaceDeletionRequest(opts: ReplaceDeletionRequestOptions): Promise<DeletionRequest>;
+    requestAccountDeletion(opts: RequestAccountDeletionOptions): Promise<AccountDeletion>;
     createAccountLock(opts: CreateAccountLockOptions): Promise<AccountLock>;
     replaceAccountLock(opts: ReplaceAccountLockOptions): Promise<AccountLock>;
+    getAccountLock(opts: GetAccountLockOptions): Promise<AccountLock | undefined>;
     watchAccountLock(opts: WatchAccountLockOptions): Promise<StopAccountLockWatch>;
+    exportData(): Promise<PrivacyExport>;
 }
 export declare class PrivacyFX implements PrivacyFXOperator {
     private privacy;
     constructor(opts: PrivacyFXOptions);
     createDeletionRequest(opts: CreateDeletionRequestOptions): Promise<DeletionRequest>;
     replaceDeletionRequest(opts: ReplaceDeletionRequestOptions): Promise<DeletionRequest>;
+    requestAccountDeletion(opts: RequestAccountDeletionOptions): Promise<AccountDeletion>;
     createAccountLock(opts: CreateAccountLockOptions): Promise<AccountLock>;
     replaceAccountLock(opts: ReplaceAccountLockOptions): Promise<AccountLock>;
+    getAccountLock(opts: GetAccountLockOptions): Promise<AccountLock | undefined>;
     watchAccountLock(opts: WatchAccountLockOptions): Promise<StopAccountLockWatch>;
+    exportData(): Promise<PrivacyExport>;
+    private requiredOwnerID;
     private resolveDeletionRequest;
     private resolveAccountLock;
     private findOwnerAccountLock;

package/dist/src/privacy/privacy.js

@@ -3,8 +3,9 @@
 // Licensed under the Apache License, Version 2.0 (the "License"); you may
 // not use this file except in compliance with the License. You may obtain
 // a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
-import { ZeroID, } from "@fabriktor/schema";
-import { errRequired, errResolveFailed, } from "../core/err.js";
+import { queryParam, } from "@fabriktor/client";
+import { OwnerIDKey, ZeroID, } from "@fabriktor/schema";
+import { errRequired, errResolveFailed } from "../core/err.js";
 import { requiredOperationID } from "../core/id.js";
 const accountLockIntervalMs = 60 * 60 * 1000;
 const resourceDeletionRequest = "deletion_request";
@@ -14,6 +15,7 @@ const msgCreatedDeletionRequestIDMissing = "Created deletion request response di
 const msgDeletionRequestMissing = "Deletion request could not be resolved after the mutation.";
 const msgCreatedAccountLockIDMissing = "Created account lock response did not contain an ID.";
 const msgAccountLockMissing = "Account lock could not be resolved after the mutation.";
+const msgDeletionAccountLockMissing = "Account lock could not be resolved after the deletion request.";
 export class PrivacyFX {
     privacy;
     constructor(opts) {
@@ -28,6 +30,18 @@ export class PrivacyFX {
         await this.privacy.replaceOneDeletionRequest(opts);
         return await this.resolveDeletionRequest(opts.id);
     }
+    async requestAccountDeletion(opts) {
+        const owner_id = this.requiredOwnerID(opts.owner_id);
+        const request = await this.createDeletionRequest({ in: opts.in });
+        const lock = await this.findOwnerAccountLock(owner_id);
+        if (lock === undefined) {
+            throw errResolveFailed({
+                resource: resourceAccountLock,
+                msg: msgDeletionAccountLockMissing,
+            });
+        }
+        return { request, lock };
+    }
     async createAccountLock(opts) {
         const out = await this.privacy.insertOneAccountLock(opts);
         const id = requiredOperationID(out, msgCreatedAccountLockIDMissing);
@@ -37,14 +51,11 @@ export class PrivacyFX {
         await this.privacy.replaceOneAccountLock(opts);
         return await this.resolveAccountLock(opts.id);
     }
+    async getAccountLock(opts) {
+        return await this.findOwnerAccountLock(this.requiredOwnerID(opts.owner_id));
+    }
     async watchAccountLock(opts) {
-        const owner_id = opts.owner_id.trim();
-        if (owner_id === "" || owner_id === ZeroID) {
-            throw errRequired({
-                field: "owner_id",
-                msg: msgOwnerIDRequired,
-            });
-        }
+        const owner_id = this.requiredOwnerID(opts.owner_id);
         const initial_lock = await this.findOwnerAccountLock(owner_id);
         if (initial_lock !== undefined) {
             opts.on_lock(initial_lock);
@@ -89,10 +100,21 @@ export class PrivacyFX {
             }
         };
     }
+    async exportData() {
+        return await this.privacy.exportData();
+    }
+    requiredOwnerID(owner_id) {
+        const id = owner_id.trim();
+        if (id === "" || id === ZeroID) {
+            throw errRequired({
+                field: "owner_id",
+                msg: msgOwnerIDRequired,
+            });
+        }
+        return id;
+    }
     async resolveDeletionRequest(id) {
-        const out = await this.privacy.findOneDeletionRequest({
-            id,
-        });
+        const out = await this.privacy.findOneDeletionRequest({ id });
         const deletion_request = out.value;
         if (deletion_request === undefined) {
             throw errResolveFailed({
@@ -103,9 +125,7 @@ export class PrivacyFX {
         return deletion_request;
     }
     async resolveAccountLock(id) {
-        const out = await this.privacy.findOneAccountLock({
-            id,
-        });
+        const out = await this.privacy.findOneAccountLock({ id });
         const account_lock = out.value;
         if (account_lock === undefined) {
             throw errResolveFailed({
@@ -117,9 +137,7 @@ export class PrivacyFX {
     }
     async findOwnerAccountLock(owner_id) {
         const out = await this.privacy.queryAccountLocks({
-            query: {
-                owner_id,
-            },
+            query: queryParam(OwnerIDKey, owner_id),
         });
         return out.value?.[0];
     }

package/package.json

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