@didcid/keymaster 0.3.8 → 0.3.10

package/README.md

@@ -234,11 +234,11 @@ keymaster list-ids
 | `create-asset` | Create empty asset |
 | `create-asset-json <file>` | Create from JSON file |
 | `create-asset-image <file>` | Create from image |
-| `create-asset-document <file>` | Create from document |
+| `create-asset-file <file>` | Create from file |
 | `get-asset <id>` | Get asset by ID |
 | `update-asset-json <id> <file>` | Update with JSON |
 | `update-asset-image <id> <file>` | Update with image |
-| `update-asset-document <id> <file>` | Update with document |
+| `update-asset-file <id> <file>` | Update with file |
 | `transfer-asset <id> <controller>` | Transfer ownership |
 | `clone-asset <id>` | Clone an asset |
 | `set-property <id> <key> [value]` | Set asset property |

package/dist/cjs/keymaster-client.cjs

@@ -388,7 +388,7 @@ class KeymasterClient {
             throwError(error);
         }
     }
-    async updateAsset(id, data) {
+    async mergeData(id, data) {
         try {
             const response = await axios.put(`${this.API}/assets/${id}`, { data });
             return response.data.ok;
@@ -748,7 +748,7 @@ class KeymasterClient {
                 headers: {
                     // eslint-disable-next-line
                     'Content-Type': 'application/octet-stream',
-                    'X-Options': JSON.stringify(options), // Pass options as a custom header
+                    'X-Options': JSON.stringify(options),
                 }
             });
             return response.data.did;
@@ -757,11 +757,12 @@ class KeymasterClient {
             throwError(error);
         }
     }
-    async updateImage(id, data) {
+    async updateImage(id, data, options = {}) {
         try {
             const response = await axios.put(`${this.API}/images/${id}`, data, {
                 headers: {
-                    'Content-Type': 'application/octet-stream'
+                    'Content-Type': 'application/octet-stream',
+                    'X-Options': JSON.stringify(options),
                 }
             });
             return response.data.ok;
@@ -773,7 +774,7 @@ class KeymasterClient {
     async getImage(id) {
         try {
             const response = await axios.get(`${this.API}/images/${id}`);
-            return response.data.image;
+            return response.data;
         }
         catch (error) {
             throwError(error);
@@ -788,9 +789,9 @@ class KeymasterClient {
             throwError(error);
         }
     }
-    async createDocument(data, options = {}) {
+    async createFile(data, options = {}) {
         try {
-            const response = await axios.post(`${this.API}/documents`, data, {
+            const response = await axios.post(`${this.API}/files`, data, {
                 headers: {
                     'Content-Type': 'application/octet-stream',
                     'X-Options': JSON.stringify(options), // Pass options as a custom header
@@ -802,9 +803,9 @@ class KeymasterClient {
             throwError(error);
         }
     }
-    async updateDocument(id, data, options = {}) {
+    async updateFile(id, data, options = {}) {
         try {
-            const response = await axios.put(`${this.API}/documents/${id}`, data, {
+            const response = await axios.put(`${this.API}/files/${id}`, data, {
                 headers: {
                     'Content-Type': 'application/octet-stream',
                     'X-Options': JSON.stringify(options), // Pass options as a custom header
@@ -816,18 +817,18 @@ class KeymasterClient {
             throwError(error);
         }
     }
-    async getDocument(id) {
+    async getFile(id) {
         try {
-            const response = await axios.get(`${this.API}/documents/${id}`);
-            return response.data.document;
+            const response = await axios.get(`${this.API}/files/${id}`);
+            return response.data.file;
         }
         catch (error) {
             throwError(error);
         }
     }
-    async testDocument(id) {
+    async testFile(id) {
         try {
-            const response = await axios.post(`${this.API}/documents/${id}/test`);
+            const response = await axios.post(`${this.API}/files/${id}/test`);
             return response.data.test;
         }
         catch (error) {

package/dist/cjs/keymaster.cjs

@@ -1658,7 +1658,7 @@ class Keymaster {
         const cloneData = { ...assetData, cloned: assetDoc.didDocument.id };
         return this.createAsset(cloneData, options);
     }
-    async generateImageAsset(buffer) {
+    async generateImageAsset(filename, buffer) {
         let metadata;
         try {
             metadata = imageSize.imageSize(buffer);
@@ -1667,33 +1667,38 @@ class Keymaster {
             throw new InvalidParameterError('buffer');
         }
         const cid = await this.gatekeeper.addData(buffer);
-        const image = {
+        const file = {
             cid,
+            filename,
+            type: `image/${metadata.type}`,
             bytes: buffer.length,
-            ...metadata,
-            type: `image/${metadata.type}`
         };
-        return image;
+        const image = {
+            width: metadata.width,
+            height: metadata.height,
+        };
+        return { file, image };
     }
     async createImage(buffer, options = {}) {
-        const image = await this.generateImageAsset(buffer);
-        return this.createAsset({ image }, options);
+        const filename = options.filename || 'image';
+        const { file, image } = await this.generateImageAsset(filename, buffer);
+        return this.createAsset({ file, image }, options);
     }
-    async updateImage(id, buffer) {
-        const image = await this.generateImageAsset(buffer);
-        return this.updateAsset(id, { image });
+    async updateImage(id, buffer, options = {}) {
+        const filename = options.filename || 'image';
+        const { file, image } = await this.generateImageAsset(filename, buffer);
+        return this.mergeData(id, { file, image });
     }
     async getImage(id) {
         const asset = await this.resolveAsset(id);
-        const image = asset.image;
-        if (!image || !image.cid) {
+        if (!asset.file || !asset.file.cid || !asset.image) {
             return null;
         }
-        const buffer = await this.gatekeeper.getData(image.cid);
+        const buffer = await this.gatekeeper.getData(asset.file.cid);
         if (buffer) {
-            image.data = buffer;
+            asset.file.data = buffer;
         }
-        return image;
+        return { file: asset.file, image: asset.image };
     }
     async testImage(id) {
         try {
@@ -1736,24 +1741,32 @@ class Keymaster {
         };
         return file;
     }
-    async createDocument(buffer, options = {}) {
-        const filename = options.filename || 'document';
-        const document = await this.generateFileAsset(filename, buffer);
-        return this.createAsset({ document }, options);
+    async createFile(buffer, options = {}) {
+        const filename = options.filename || 'file';
+        const file = await this.generateFileAsset(filename, buffer);
+        return this.createAsset({ file }, options);
     }
-    async updateDocument(id, buffer, options = {}) {
-        const filename = options.filename || 'document';
-        const document = await this.generateFileAsset(filename, buffer);
-        return this.updateAsset(id, { document });
+    async updateFile(id, buffer, options = {}) {
+        const filename = options.filename || 'file';
+        const file = await this.generateFileAsset(filename, buffer);
+        return this.mergeData(id, { file });
     }
-    async getDocument(id) {
+    async getFile(id) {
         const asset = await this.resolveAsset(id);
-        return asset.document ?? null;
+        const file = asset.file;
+        if (!file || !file.cid) {
+            return null;
+        }
+        const buffer = await this.gatekeeper.getData(file.cid);
+        if (buffer) {
+            file.data = buffer;
+        }
+        return file;
     }
-    async testDocument(id) {
+    async testFile(id) {
         try {
-            const document = await this.getDocument(id);
-            return document !== null;
+            const file = await this.getFile(id);
+            return file !== null;
         }
         catch (error) {
             return false;
@@ -2037,13 +2050,14 @@ class Keymaster {
         }
         return doc.didDocumentData;
     }
-    async updateAsset(did, data) {
+    async mergeData(did, data) {
         const doc = await this.resolveDID(did);
         const currentData = doc.didDocumentData || {};
-        const updatedData = {
-            ...currentData,
-            ...data
-        };
+        const updatedData = { ...currentData, ...data };
+        for (const key of Object.keys(updatedData)) {
+            if (updatedData[key] === null)
+                delete updatedData[key];
+        }
         return this.updateDID(did, { didDocumentData: updatedData });
     }
     async transferAsset(id, controller) {
@@ -2761,7 +2775,7 @@ class Keymaster {
         const members = new Set(group.members);
         members.add(memberDID);
         group.members = Array.from(members);
-        return this.updateAsset(groupDID, { group });
+        return this.mergeData(groupDID, { group });
     }
     async removeGroupMember(groupId, memberId) {
         const groupDID = await this.lookupDID(groupId);
@@ -2784,7 +2798,7 @@ class Keymaster {
         const members = new Set(group.members);
         members.delete(memberDID);
         group.members = Array.from(members);
-        return this.updateAsset(groupDID, { group });
+        return this.mergeData(groupDID, { group });
     }
     async testGroup(groupId, memberId) {
         try {
@@ -2875,7 +2889,7 @@ class Keymaster {
         if (!this.validateSchema(schema)) {
             throw new InvalidParameterError('schema');
         }
-        return this.updateAsset(id, { schema });
+        return this.mergeData(id, { schema });
     }
     // TBD add optional 2nd parameter that will validate JSON against the schema
     async testSchema(id) {
@@ -3151,7 +3165,7 @@ class Keymaster {
             ballot: didBallot,
             received: new Date().toISOString(),
         };
-        return this.updateAsset(didPoll, { poll });
+        return this.mergeData(didPoll, { poll });
     }
     async publishPoll(pollId, options = {}) {
         const { reveal = false } = options;
@@ -3173,7 +3187,7 @@ class Keymaster {
             throw new InvalidParameterError(pollId);
         }
         poll.results = view.results;
-        return this.updateAsset(pollId, { poll });
+        return this.mergeData(pollId, { poll });
     }
     async unpublishPoll(pollId) {
         const id = await this.fetchIdInfo();
@@ -3187,7 +3201,7 @@ class Keymaster {
             throw new InvalidParameterError(pollId);
         }
         delete poll.results;
-        return this.updateAsset(pollId, { poll });
+        return this.mergeData(pollId, { poll });
     }
     async createVault(options = {}) {
         const id = await this.fetchIdInfo();
@@ -3316,7 +3330,7 @@ class Keymaster {
             for (const memberDID of Object.keys(members)) {
                 await this.addMemberKey(vault, memberDID, privateJwk);
             }
-            await this.updateAsset(vaultId, { vault });
+            await this.mergeData(vaultId, { vault });
             return;
         }
         throw new KeymasterError('Unsupported vault version');
@@ -3346,7 +3360,7 @@ class Keymaster {
         const publicJwk = config.secretMembers ? idKeypair.publicJwk : vault.publicJwk;
         vault.members = this.cipher.encryptMessage(publicJwk, privateJwk, JSON.stringify(members));
         await this.addMemberKey(vault, memberDID, privateJwk);
-        return this.updateAsset(vaultId, { vault });
+        return this.mergeData(vaultId, { vault });
     }
     async removeVaultMember(vaultId, memberId) {
         const owner = await this.checkVaultOwner(vaultId);
@@ -3364,7 +3378,7 @@ class Keymaster {
         vault.members = this.cipher.encryptMessage(publicJwk, privateJwk, JSON.stringify(members));
         const memberKeyId = this.generateSaltedId(vault, memberDID);
         delete vault.keys[memberKeyId];
-        return this.updateAsset(vaultId, { vault });
+        return this.mergeData(vaultId, { vault });
     }
     async listVaultMembers(vaultId) {
         const vault = await this.getVault(vaultId);
@@ -3394,7 +3408,7 @@ class Keymaster {
         };
         vault.items = this.cipher.encryptMessage(vault.publicJwk, privateJwk, JSON.stringify(items));
         vault.sha256 = this.cipher.hashJSON(items);
-        return this.updateAsset(vaultId, { vault });
+        return this.mergeData(vaultId, { vault });
     }
     async removeVaultItem(vaultId, name) {
         await this.checkVaultOwner(vaultId);
@@ -3403,7 +3417,7 @@ class Keymaster {
         delete items[name];
         vault.items = this.cipher.encryptMessage(vault.publicJwk, privateJwk, JSON.stringify(items));
         vault.sha256 = this.cipher.hashJSON(items);
-        return this.updateAsset(vaultId, { vault });
+        return this.mergeData(vaultId, { vault });
     }
     async listVaultItems(vaultId, options) {
         const vault = await this.getVault(vaultId, options);
@@ -3654,7 +3668,7 @@ class Keymaster {
     }
     async updateNotice(id, message) {
         const notice = await this.verifyNotice(message);
-        return this.updateAsset(id, { notice });
+        return this.mergeData(id, { notice });
     }
     async addToNotices(did, tags) {
         const verifiedTags = this.verifyTagList(tags);

package/dist/esm/cli.js

@@ -827,7 +827,8 @@ program
     try {
         const { alias, registry } = options;
         const data = fs.readFileSync(file);
-        const did = await keymaster.createImage(data, { alias, registry });
+        const filename = path.basename(file);
+        const did = await keymaster.createImage(data, { filename, alias, registry });
         console.log(did);
     }
     catch (error) {
@@ -835,8 +836,8 @@ program
     }
 });
 program
-    .command('create-asset-document <file>')
-    .description('Create an asset from a document file')
+    .command('create-asset-file <file>')
+    .description('Create an asset from a file')
     .option('-a, --alias <alias>', 'DID alias')
     .option('-r, --registry <registry>', 'registry to use')
     .action(async (file, options) => {
@@ -844,7 +845,7 @@ program
         const { alias, registry } = options;
         const data = fs.readFileSync(file);
         const filename = path.basename(file);
-        const did = await keymaster.createDocument(data, { filename, alias, registry });
+        const did = await keymaster.createFile(data, { filename, alias, registry });
         console.log(did);
     }
     catch (error) {
@@ -863,13 +864,62 @@ program
         console.error(error.error || error.message || error);
     }
 });
+program
+    .command('get-asset-json <id> <file>')
+    .description('Save a JSON asset to a file')
+    .action(async (id, file) => {
+    try {
+        const asset = await keymaster.resolveAsset(id);
+        fs.writeFileSync(file, JSON.stringify(asset, null, 4));
+        console.log(`Data written to ${file}`);
+    }
+    catch (error) {
+        console.error(error.error || error.message || error);
+    }
+});
+program
+    .command('get-asset-image <id> [file]')
+    .description('Save an image asset to a file')
+    .action(async (id, file) => {
+    try {
+        const imageAsset = await keymaster.getImage(id);
+        if (!imageAsset || !imageAsset.file.data) {
+            console.error('Image not found');
+            return;
+        }
+        const outputFile = file || imageAsset.file.filename;
+        fs.writeFileSync(outputFile, imageAsset.file.data);
+        console.log(`Data written to ${outputFile}`);
+    }
+    catch (error) {
+        console.error(error.error || error.message || error);
+    }
+});
+program
+    .command('get-asset-file <id> [file]')
+    .description('Save a file asset to a file')
+    .action(async (id, file) => {
+    try {
+        const fileAsset = await keymaster.getFile(id);
+        if (!fileAsset || !fileAsset.data) {
+            console.error('File not found');
+            return;
+        }
+        const outputFile = file || fileAsset.filename;
+        fs.writeFileSync(outputFile, fileAsset.data);
+        console.log(`Data written to ${outputFile}`);
+    }
+    catch (error) {
+        console.error(error.error || error.message || error);
+    }
+});
 program
     .command('update-asset-json <id> <file>')
     .description('Update an asset from a JSON file')
     .action(async (id, file) => {
     try {
         const data = JSON.parse(fs.readFileSync(file).toString());
-        const ok = await keymaster.updateAsset(id, data);
+        const ok = await keymaster.mergeData(id, data);
         console.log(ok ? UPDATE_OK : UPDATE_FAILED);
     }
     catch (error) {
@@ -882,7 +932,8 @@ program
     .action(async (id, file) => {
     try {
         const data = fs.readFileSync(file);
-        const ok = await keymaster.updateImage(id, data);
+        const filename = path.basename(file);
+        const ok = await keymaster.updateImage(id, data, { filename });
         console.log(ok ? UPDATE_OK : UPDATE_FAILED);
     }
     catch (error) {
@@ -890,13 +941,13 @@ program
     }
 });
 program
-    .command('update-asset-document <id> <file>')
-    .description('Update an asset from a document file')
+    .command('update-asset-file <id> <file>')
+    .description('Update an asset from a file')
     .action(async (id, file) => {
     try {
         const data = fs.readFileSync(file);
         const filename = path.basename(file);
-        const ok = await keymaster.updateDocument(id, data, { filename });
+        const ok = await keymaster.updateFile(id, data, { filename });
         console.log(ok ? UPDATE_OK : UPDATE_FAILED);
     }
     catch (error) {
@@ -930,24 +981,37 @@ program
         console.error(error.error || error.message || error);
     }
 });
+program
+    .command('get-property <id> <key>')
+    .description('Get a property value from a DID')
+    .action(async (id, key) => {
+    try {
+        const doc = await keymaster.resolveDID(id);
+        const data = doc.didDocumentData || {};
+        const value = data[key];
+        if (value !== undefined) {
+            console.log(JSON.stringify(value, null, 4));
+        }
+    }
+    catch (error) {
+        console.error(error.error || error.message || error);
+    }
+});
 program
     .command('set-property <id> <key> [value]')
-    .description('Assign a key-value pair to an asset')
+    .description('Assign a key-value pair to a DID')
     .action(async (id, key, value) => {
     try {
-        const data = await keymaster.resolveAsset(id);
+        let parsed = null;
         if (value) {
             try {
-                data[key] = JSON.parse(value);
+                parsed = JSON.parse(value);
             }
             catch {
-                data[key] = value;
+                parsed = value;
             }
         }
-        else {
-            delete data[key];
-        }
-        const ok = await keymaster.updateAsset(id, data);
+        const ok = await keymaster.mergeData(id, { [key]: parsed });
         console.log(ok ? UPDATE_OK : UPDATE_FAILED);
     }
     catch (error) {
@@ -1290,7 +1354,7 @@ program
 });
 program
     .command('remove-dmail <did>')
-    .description('Remove a dmail from inbox')
+    .description('Delete a dmail')
     .action(async (did) => {
     try {
         const ok = await keymaster.removeDmail(did);