@violetix/baileys 0.0.0-stage → 0.3.18

package/lib/WAM/encode.d.ts

@@ -0,0 +1,2 @@
+export function encodeWAM(binaryInfo: any): any;
+//# sourceMappingURL=encode.d.ts.map

package/lib/WAM/encode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encode.d.ts","sourceRoot":"","sources":["../../src/WAM/encode.js"],"names":[],"mappings":"AAGO,gDAYN"}

package/lib/WAM/encode.js

@@ -0,0 +1,150 @@
+import { BinaryInfo } from './BinaryInfo.js';
+import { FLAG_BYTE, FLAG_EVENT, FLAG_EXTENDED, FLAG_FIELD, FLAG_GLOBAL, WEB_EVENTS, WEB_GLOBALS } from './constants.js';
+const getHeaderBitLength = (key) => (key < 256 ? 2 : 3);
+export const encodeWAM = (binaryInfo) => {
+    binaryInfo.buffer = [];
+    encodeWAMHeader(binaryInfo);
+    encodeEvents(binaryInfo);
+    const totalSize = binaryInfo.buffer.map(a => a.length).reduce((a, b) => a + b);
+    const buffer = Buffer.alloc(totalSize);
+    let offset = 0;
+    for (const buffer_ of binaryInfo.buffer) {
+        buffer_.copy(buffer, offset);
+        offset += buffer_.length;
+    }
+    return buffer;
+};
+function encodeWAMHeader(binaryInfo) {
+    const headerBuffer = Buffer.alloc(8); // starting buffer
+    headerBuffer.write('WAM', 0, 'utf8');
+    headerBuffer.writeUInt8(binaryInfo.protocolVersion, 3);
+    headerBuffer.writeUInt8(1, 4); //random flag
+    headerBuffer.writeUInt16BE(binaryInfo.sequence, 5);
+    headerBuffer.writeUInt8(0, 7); // regular channel
+    binaryInfo.buffer.push(headerBuffer);
+}
+function encodeGlobalAttributes(binaryInfo, globals) {
+    for (const [key, _value] of Object.entries(globals)) {
+        const id = WEB_GLOBALS.find(a => a?.name === key).id;
+        let value = _value;
+        if (typeof value === 'boolean') {
+            value = value ? 1 : 0;
+        }
+        binaryInfo.buffer.push(serializeData(id, value, FLAG_GLOBAL));
+    }
+}
+function encodeEvents(binaryInfo) {
+    for (const [name, { props, globals }] of binaryInfo.events.map(a => Object.entries(a)[0])) {
+        encodeGlobalAttributes(binaryInfo, globals);
+        const event = WEB_EVENTS.find(a => a.name === name);
+        const props_ = Object.entries(props);
+        let extended = false;
+        for (const [, value] of props_) {
+            extended || (extended = value !== null);
+        }
+        const eventFlag = extended ? FLAG_EVENT : FLAG_EVENT | FLAG_EXTENDED;
+        binaryInfo.buffer.push(serializeData(event.id, -event.weight, eventFlag));
+        for (let i = 0; i < props_.length; i++) {
+            const [key, _value] = props_[i];
+            const id = event.props[key]?.[0];
+            extended = i < props_.length - 1;
+            let value = _value;
+            if (typeof value === 'boolean') {
+                value = value ? 1 : 0;
+            }
+            const fieldFlag = extended ? FLAG_EVENT : FLAG_FIELD | FLAG_EXTENDED;
+            binaryInfo.buffer.push(serializeData(id, value, fieldFlag));
+        }
+    }
+}
+function serializeData(key, value, flag) {
+    const bufferLength = getHeaderBitLength(key);
+    let buffer;
+    let offset = 0;
+    if (value === null) {
+        if (flag === FLAG_GLOBAL) {
+            buffer = Buffer.alloc(bufferLength);
+            offset = serializeHeader(buffer, offset, key, flag);
+            return buffer;
+        }
+    }
+    else if (typeof value === 'number' && Number.isInteger(value)) {
+        // is number
+        if (value === 0 || value === 1) {
+            buffer = Buffer.alloc(bufferLength);
+            offset = serializeHeader(buffer, offset, key, flag | ((value + 1) << 4));
+            return buffer;
+        }
+        else if (-128 <= value && value < 128) {
+            buffer = Buffer.alloc(bufferLength + 1);
+            offset = serializeHeader(buffer, offset, key, flag | (3 << 4));
+            buffer.writeInt8(value, offset);
+            return buffer;
+        }
+        else if (-32768 <= value && value < 32768) {
+            buffer = Buffer.alloc(bufferLength + 2);
+            offset = serializeHeader(buffer, offset, key, flag | (4 << 4));
+            buffer.writeInt16LE(value, offset);
+            return buffer;
+        }
+        else if (-2147483648 <= value && value < 2147483648) {
+            buffer = Buffer.alloc(bufferLength + 4);
+            offset = serializeHeader(buffer, offset, key, flag | (5 << 4));
+            buffer.writeInt32LE(value, offset);
+            return buffer;
+        }
+        else {
+            buffer = Buffer.alloc(bufferLength + 8);
+            offset = serializeHeader(buffer, offset, key, flag | (7 << 4));
+            buffer.writeDoubleLE(value, offset);
+            return buffer;
+        }
+    }
+    else if (typeof value === 'number') {
+        // is float
+        buffer = Buffer.alloc(bufferLength + 8);
+        offset = serializeHeader(buffer, offset, key, flag | (7 << 4));
+        buffer.writeDoubleLE(value, offset);
+        return buffer;
+    }
+    else if (typeof value === 'string') {
+        // is string
+        const utf8Bytes = Buffer.byteLength(value, 'utf8');
+        if (utf8Bytes < 256) {
+            buffer = Buffer.alloc(bufferLength + 1 + utf8Bytes);
+            offset = serializeHeader(buffer, offset, key, flag | (8 << 4));
+            buffer.writeUint8(utf8Bytes, offset++);
+        }
+        else if (utf8Bytes < 65536) {
+            buffer = Buffer.alloc(bufferLength + 2 + utf8Bytes);
+            offset = serializeHeader(buffer, offset, key, flag | (9 << 4));
+            buffer.writeUInt16LE(utf8Bytes, offset);
+            offset += 2;
+        }
+        else {
+            buffer = Buffer.alloc(bufferLength + 4 + utf8Bytes);
+            offset = serializeHeader(buffer, offset, key, flag | (10 << 4));
+            buffer.writeUInt32LE(utf8Bytes, offset);
+            offset += 4;
+        }
+        buffer.write(value, offset, 'utf8');
+        return buffer;
+    }
+    throw 'missing';
+}
+function serializeHeader(buffer, offset, key, flag) {
+    if (key < 256) {
+        buffer.writeUInt8(flag, offset);
+        offset += 1;
+        buffer.writeUInt8(key, offset);
+        offset += 1;
+    }
+    else {
+        buffer.writeUInt8(flag | FLAG_BYTE, offset);
+        offset += 1;
+        buffer.writeUInt16LE(key, offset);
+        offset += 2;
+    }
+    return offset;
+}
+//# sourceMappingURL=encode.js.map

package/lib/WAM/encode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encode.js","sourceRoot":"","sources":["../../src/WAM/encode.js"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AACxH,MAAM,kBAAkB,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACxD,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,UAAU,EAAE,EAAE;IACpC,UAAU,CAAC,MAAM,GAAG,EAAE,CAAC;IACvB,eAAe,CAAC,UAAU,CAAC,CAAC;IAC5B,YAAY,CAAC,UAAU,CAAC,CAAC;IACzB,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/E,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACvC,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,OAAO,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;QACtC,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC7B,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AACF,SAAS,eAAe,CAAC,UAAU;IAC/B,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,kBAAkB;IACxD,YAAY,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;IACrC,YAAY,CAAC,UAAU,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;IACvD,YAAY,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,aAAa;IAC5C,YAAY,CAAC,aAAa,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACnD,YAAY,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,kBAAkB;IACjD,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;AACzC,CAAC;AACD,SAAS,sBAAsB,CAAC,UAAU,EAAE,OAAO;IAC/C,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAClD,MAAM,EAAE,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;QACrD,IAAI,KAAK,GAAG,MAAM,CAAC;QACnB,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;YAC7B,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1B,CAAC;QACD,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC;IAClE,CAAC;AACL,CAAC;AACD,SAAS,YAAY,CAAC,UAAU;IAC5B,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACxF,sBAAsB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAC5C,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,EAAE,CAAC;YAC7B,QAAQ,IAAI,CAAC,QAAQ,GAAG,KAAK,KAAK,IAAI,CAAC,CAAC;QAC5C,CAAC;QACD,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,GAAG,aAAa,CAAC;QACrE,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;QAC1E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YAChC,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACjC,QAAQ,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;YACjC,IAAI,KAAK,GAAG,MAAM,CAAC;YACnB,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC7B,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1B,CAAC;YACD,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,GAAG,aAAa,CAAC;YACrE,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC;QAChE,CAAC;IACL,CAAC;AACL,CAAC;AACD,SAAS,aAAa,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI;IACnC,MAAM,YAAY,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAC7C,IAAI,MAAM,CAAC;IACX,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACjB,IAAI,IAAI,KAAK,WAAW,EAAE,CAAC;YACvB,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YACpC,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;YACpD,OAAO,MAAM,CAAC;QAClB,CAAC;IACL,CAAC;SACI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5D,YAAY;QACZ,IAAI,KAAK,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YACpC,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACzE,OAAO,MAAM,CAAC;QAClB,CAAC;aACI,IAAI,CAAC,GAAG,IAAI,KAAK,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;YACpC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;YACxC,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC/D,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAChC,OAAO,MAAM,CAAC;QAClB,CAAC;aACI,IAAI,CAAC,KAAK,IAAI,KAAK,IAAI,KAAK,GAAG,KAAK,EAAE,CAAC;YACxC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;YACxC,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC/D,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YACnC,OAAO,MAAM,CAAC;QAClB,CAAC;aACI,IAAI,CAAC,UAAU,IAAI,KAAK,IAAI,KAAK,GAAG,UAAU,EAAE,CAAC;YAClD,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;YACxC,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC/D,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YACnC,OAAO,MAAM,CAAC;QAClB,CAAC;aACI,CAAC;YACF,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;YACxC,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC/D,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YACpC,OAAO,MAAM,CAAC;QAClB,CAAC;IACL,CAAC;SACI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACjC,WAAW;QACX,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QACxC,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC/D,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACpC,OAAO,MAAM,CAAC;IAClB,CAAC;SACI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACjC,YAAY;QACZ,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACnD,IAAI,SAAS,GAAG,GAAG,EAAE,CAAC;YAClB,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC;YACpD,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC/D,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;QAC3C,CAAC;aACI,IAAI,SAAS,GAAG,KAAK,EAAE,CAAC;YACzB,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC;YACpD,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC/D,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YACxC,MAAM,IAAI,CAAC,CAAC;QAChB,CAAC;aACI,CAAC;YACF,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC;YACpD,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;YAChE,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YACxC,MAAM,IAAI,CAAC,CAAC;QAChB,CAAC;QACD,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QACpC,OAAO,MAAM,CAAC;IAClB,CAAC;IACD,MAAM,SAAS,CAAC;AACpB,CAAC;AACD,SAAS,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI;IAC9C,IAAI,GAAG,GAAG,GAAG,EAAE,CAAC;QACZ,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAChC,MAAM,IAAI,CAAC,CAAC;QACZ,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAC/B,MAAM,IAAI,CAAC,CAAC;IAChB,CAAC;SACI,CAAC;QACF,MAAM,CAAC,UAAU,CAAC,IAAI,GAAG,SAAS,EAAE,MAAM,CAAC,CAAC;QAC5C,MAAM,IAAI,CAAC,CAAC;QACZ,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAClC,MAAM,IAAI,CAAC,CAAC;IAChB,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC"}

package/lib/WAM/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./constants.js";
+export * from "./encode.js";
+export * from "./BinaryInfo.js";
+//# sourceMappingURL=index.d.ts.map

package/lib/WAM/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/WAM/index.js"],"names":[],"mappings":""}

package/lib/WAM/index.js

@@ -0,0 +1,4 @@
+export * from './constants.js';
+export * from './encode.js';
+export * from './BinaryInfo.js';
+//# sourceMappingURL=index.js.map

package/lib/WAM/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/WAM/index.js"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC"}

package/lib/WAUSync/Protocols/USyncBusinessProtocol.d.ts

@@ -0,0 +1,8 @@
+export class USyncBusinessProtocol {
+    constructor(profileVersion?: string);
+    name: string;
+    profileVersion: string;
+    getQueryElement(): any;
+    getUserElement(user: any): any;
+    parser(node: any): any;
+}

package/lib/WAUSync/Protocols/USyncBusinessProtocol.js

@@ -0,0 +1,99 @@
+import { getBinaryNodeChild, getBinaryNodeChildren } from '../../WABinary/index.js';
+export class USyncBusinessProtocol {
+	constructor(profileVersion = '2') {
+		this.name = 'business'
+		this.profileVersion = profileVersion
+	}
+	getQueryElement() {
+		return {
+			tag: 'business',
+			attrs: {},
+			content: [
+				{ tag: 'verified_name', attrs: {} },
+				// pass a falsy profileVersion to ask for the verified name only
+				...(this.profileVersion ? [{ tag: 'profile', attrs: { v: this.profileVersion } }] : [])
+			]
+		}
+	}
+	getUserElement(user) {
+		const children = []
+		if (user.verifiedNameSerial) {
+			children.push({ tag: 'verified_name', attrs: { serial: user.verifiedNameSerial } })
+		}
+		if (user.businessProfileTag) {
+			children.push({ tag: 'profile', attrs: { tag: user.businessProfileTag } })
+		}
+		return children.length > 0 ? { tag: 'business', attrs: {}, content: children } : null
+	}
+	parser(node) {
+		if (node.tag !== 'business') return null
+		// a non-business contact answers with an <error/> child; that is "no business profile",
+		// not a query failure, so it must not abort the whole usync result
+		if (getBinaryNodeChild(node, 'error')) return null
+		const verifiedNameNode = getBinaryNodeChild(node, 'verified_name')
+		const profileNode = getBinaryNodeChild(node, 'profile')
+
+		// Business hours: profile may contain a business_hours child with business_hours_config children
+		let businessHours = undefined
+		if (profileNode) {
+			const businessHoursNode = getBinaryNodeChild(profileNode, 'business_hours')
+			if (businessHoursNode) {
+				const configs = getBinaryNodeChildren(businessHoursNode, 'business_hours_config')
+				businessHours = {
+					timezone: businessHoursNode.attrs?.timezone ?? null,
+					config: configs.map(({ attrs }) => ({
+						dayOfWeek: attrs?.day_of_week ?? null,
+						openTime: attrs?.open_time ?? null,
+						closeTime: attrs?.close_time ?? null,
+						mode: attrs?.mode ?? null
+					}))
+				}
+			}
+		}
+
+		// Business address from profile child node
+		const addressNode = profileNode ? getBinaryNodeChild(profileNode, 'address') : null
+		const businessAddress = addressNode?.content
+			? Buffer.isBuffer(addressNode.content)
+				? addressNode.content.toString()
+				: String(addressNode.content)
+			: (profileNode?.attrs?.address ?? null)
+
+		// Catalog status from profile attrs
+		const catalogStatus = profileNode
+			? {
+					exists: profileNode.attrs?.catalog_exists === 'true' || profileNode.attrs?.catalog_exists === true,
+					sendAll: profileNode.attrs?.catalog_send_all === 'true' || profileNode.attrs?.catalog_send_all === true
+				}
+			: null
+
+		// Cart flags from profile attrs
+		const cartEnabled =
+			profileNode?.attrs?.cart_enabled !== undefined
+				? profileNode.attrs.cart_enabled === 'true' || profileNode.attrs.cart_enabled === true
+				: null
+		const webCartEnabled =
+			profileNode?.attrs?.web_cart_enabled !== undefined
+				? profileNode.attrs.web_cart_enabled === 'true' || profileNode.attrs.web_cart_enabled === true
+				: null
+		const webCartOnOff = profileNode?.attrs?.web_cart_on_off ?? null
+
+		// Commerce experience from profile attrs
+		const commerceExperience = profileNode?.attrs?.commerce_experience ?? null
+
+		return {
+			verifiedName: verifiedNameNode?.content ?? null,
+			verifiedLevel: verifiedNameNode?.attrs?.verified_level ?? null,
+			verifiedNameLevel: verifiedNameNode?.attrs?.verified_level ?? null,
+			profileTag: profileNode?.attrs?.tag ?? null,
+			pnJid: node.attrs?.pn_jid ?? null,
+			businessHours: businessHours ?? null,
+			businessAddress,
+			catalogStatus,
+			cartEnabled,
+			webCartEnabled,
+			webCartOnOff,
+			commerceExperience
+		}
+	}
+}

package/lib/WAUSync/Protocols/USyncContactProtocol.d.ts

@@ -0,0 +1,37 @@
+export class USyncContactProtocol {
+    name: string;
+    getQueryElement(): {
+        tag: string;
+        attrs: {};
+    };
+    getUserElement(user: any): {
+        tag: string;
+        attrs: {
+            type?: undefined;
+        };
+        content: any;
+    } | {
+        tag: string;
+        attrs: {
+            lid?: any;
+            pin?: any;
+            username: any;
+            type?: undefined;
+        };
+        content?: undefined;
+    } | {
+        tag: string;
+        attrs: {
+            type: any;
+        };
+        content?: undefined;
+    } | {
+        tag: string;
+        attrs: {
+            type?: undefined;
+        };
+        content?: undefined;
+    };
+    parser(node: any): boolean;
+}
+//# sourceMappingURL=USyncContactProtocol.d.ts.map

package/lib/WAUSync/Protocols/USyncContactProtocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"USyncContactProtocol.d.ts","sourceRoot":"","sources":["../../../src/WAUSync/Protocols/USyncContactProtocol.js"],"names":[],"mappings":"AAEA;IAEQ,aAAqB;IAEzB;;;MAKC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;MA8BC;IACD,2BAMC;CACJ"}

package/lib/WAUSync/Protocols/USyncContactProtocol.js

@@ -0,0 +1,53 @@
+import { assertNodeErrorFree } from '../../WABinary/index.js';
+import { USyncUser } from '../USyncUser.js';
+export class USyncContactProtocol {
+    constructor(addressingMode) {
+        this.name = 'contact';
+        this.addressingMode = addressingMode;
+    }
+    getQueryElement() {
+        return {
+            tag: 'contact',
+            attrs: this.addressingMode ? { addressing_mode: this.addressingMode } : {}
+        };
+    }
+    getUserElement(user) {
+        if (user.phone) {
+            return {
+                tag: 'contact',
+                attrs: {},
+                content: user.phone
+            };
+        }
+        if (user.username) {
+            return {
+                tag: 'contact',
+                attrs: {
+                    username: user.username,
+                    ...(user.usernameKey ? { pin: user.usernameKey } : {}),
+                    ...(user.lid ? { lid: user.lid } : {})
+                }
+            };
+        }
+        if (user.type) {
+            return {
+                tag: 'contact',
+                attrs: {
+                    type: user.type
+                }
+            };
+        }
+        return {
+            tag: 'contact',
+            attrs: {}
+        };
+    }
+    parser(node) {
+        if (node.tag === 'contact') {
+            assertNodeErrorFree(node);
+            return node?.attrs?.type === 'in';
+        }
+        return false;
+    }
+}
+//# sourceMappingURL=USyncContactProtocol.js.map

package/lib/WAUSync/Protocols/USyncContactProtocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"USyncContactProtocol.js","sourceRoot":"","sources":["../../../src/WAUSync/Protocols/USyncContactProtocol.js"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,MAAM,OAAO,oBAAoB;IAC7B;QACI,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;IAC1B,CAAC;IACD,eAAe;QACX,OAAO;YACH,GAAG,EAAE,SAAS;YACd,KAAK,EAAE,EAAE;SACZ,CAAC;IACN,CAAC;IACD,cAAc,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,OAAO;gBACH,GAAG,EAAE,SAAS;gBACd,KAAK,EAAE,EAAE;gBACT,OAAO,EAAE,IAAI,CAAC,KAAK;aACtB,CAAC;QACN,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,OAAO;gBACH,GAAG,EAAE,SAAS;gBACd,KAAK,EAAE;oBACH,QAAQ,EAAE,IAAI,CAAC,QAAQ;oBACvB,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBACtD,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACzC;aACJ,CAAC;QACN,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,OAAO;gBACH,GAAG,EAAE,SAAS;gBACd,KAAK,EAAE;oBACH,IAAI,EAAE,IAAI,CAAC,IAAI;iBAClB;aACJ,CAAC;QACN,CAAC;QACD,OAAO;YACH,GAAG,EAAE,SAAS;YACd,KAAK,EAAE,EAAE;SACZ,CAAC;IACN,CAAC;IACD,MAAM,CAAC,IAAI;QACP,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YACzB,mBAAmB,CAAC,IAAI,CAAC,CAAC;YAC1B,OAAO,IAAI,EAAE,KAAK,EAAE,IAAI,KAAK,IAAI,CAAC;QACtC,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;CACJ"}

package/lib/WAUSync/Protocols/USyncDeviceProtocol.d.ts

@@ -0,0 +1,23 @@
+export class USyncDeviceProtocol {
+    name: string;
+    getQueryElement(): {
+        tag: string;
+        attrs: {
+            version: string;
+        };
+    };
+    getUserElement(): null;
+    parser(node: any): {
+        deviceList: {
+            id: number;
+            keyIndex: number;
+            isHosted: boolean;
+        }[];
+        keyIndex: {
+            timestamp: number;
+            signedKeyIndex: any;
+            expectedTimestamp: number | undefined;
+        } | undefined;
+    };
+}
+//# sourceMappingURL=USyncDeviceProtocol.d.ts.map

package/lib/WAUSync/Protocols/USyncDeviceProtocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"USyncDeviceProtocol.d.ts","sourceRoot":"","sources":["../../../src/WAUSync/Protocols/USyncDeviceProtocol.js"],"names":[],"mappings":"AACA;IAEQ,aAAqB;IAEzB;;;;;MAOC;IACD,uBAKC;IACD;;;;;;;;;;;MAgCC;CACJ"}

package/lib/WAUSync/Protocols/USyncDeviceProtocol.js

@@ -0,0 +1,54 @@
+import { assertNodeErrorFree, getBinaryNodeChild } from '../../WABinary/index.js';
+export class USyncDeviceProtocol {
+    constructor() {
+        this.name = 'devices';
+    }
+    getQueryElement() {
+        return {
+            tag: 'devices',
+            attrs: {
+                version: '2'
+            }
+        };
+    }
+    getUserElement( /* user: USyncUser */) {
+        //TODO: Implement device phashing, ts and expectedTs
+        //TODO: if all are not present, return null <- current behavior
+        //TODO: otherwise return a node w tag 'devices' w those as attrs
+        return null;
+    }
+    parser(node) {
+        const deviceList = [];
+        let keyIndex = undefined;
+        if (node.tag === 'devices') {
+            assertNodeErrorFree(node);
+            const deviceListNode = getBinaryNodeChild(node, 'device-list');
+            const keyIndexNode = getBinaryNodeChild(node, 'key-index-list');
+            if (Array.isArray(deviceListNode?.content)) {
+                for (const { tag, attrs } of deviceListNode.content) {
+                    const id = +attrs.id;
+                    const keyIndex = +attrs['key-index'];
+                    if (tag === 'device') {
+                        deviceList.push({
+                            id,
+                            keyIndex,
+                            isHosted: !!(attrs['is_hosted'] && attrs['is_hosted'] === 'true')
+                        });
+                    }
+                }
+            }
+            if (keyIndexNode?.tag === 'key-index-list') {
+                keyIndex = {
+                    timestamp: +keyIndexNode.attrs['ts'],
+                    signedKeyIndex: keyIndexNode?.content,
+                    expectedTimestamp: keyIndexNode.attrs['expected_ts'] ? +keyIndexNode.attrs['expected_ts'] : undefined
+                };
+            }
+        }
+        return {
+            deviceList,
+            keyIndex
+        };
+    }
+}
+//# sourceMappingURL=USyncDeviceProtocol.js.map

package/lib/WAUSync/Protocols/USyncDeviceProtocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"USyncDeviceProtocol.js","sourceRoot":"","sources":["../../../src/WAUSync/Protocols/USyncDeviceProtocol.js"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClF,MAAM,OAAO,mBAAmB;IAC5B;QACI,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;IAC1B,CAAC;IACD,eAAe;QACX,OAAO;YACH,GAAG,EAAE,SAAS;YACd,KAAK,EAAE;gBACH,OAAO,EAAE,GAAG;aACf;SACJ,CAAC;IACN,CAAC;IACD,cAAc,EAAE,qBAAqB;QACjC,oDAAoD;QACpD,+DAA+D;QAC/D,gEAAgE;QAChE,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,CAAC,IAAI;QACP,MAAM,UAAU,GAAG,EAAE,CAAC;QACtB,IAAI,QAAQ,GAAG,SAAS,CAAC;QACzB,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YACzB,mBAAmB,CAAC,IAAI,CAAC,CAAC;YAC1B,MAAM,cAAc,GAAG,kBAAkB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;YAC/D,MAAM,YAAY,GAAG,kBAAkB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;YAChE,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,EAAE,CAAC;gBACzC,KAAK,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,cAAc,CAAC,OAAO,EAAE,CAAC;oBAClD,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;oBACrB,MAAM,QAAQ,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;oBACrC,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;wBACnB,UAAU,CAAC,IAAI,CAAC;4BACZ,EAAE;4BACF,QAAQ;4BACR,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,WAAW,CAAC,KAAK,MAAM,CAAC;yBACpE,CAAC,CAAC;oBACP,CAAC;gBACL,CAAC;YACL,CAAC;YACD,IAAI,YAAY,EAAE,GAAG,KAAK,gBAAgB,EAAE,CAAC;gBACzC,QAAQ,GAAG;oBACP,SAAS,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC;oBACpC,cAAc,EAAE,YAAY,EAAE,OAAO;oBACrC,iBAAiB,EAAE,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS;iBACxG,CAAC;YACN,CAAC;QACL,CAAC;QACD,OAAO;YACH,UAAU;YACV,QAAQ;SACX,CAAC;IACN,CAAC;CACJ"}

package/lib/WAUSync/Protocols/USyncDisappearingModeProtocol.d.ts

@@ -0,0 +1,13 @@
+export class USyncDisappearingModeProtocol {
+    name: string;
+    getQueryElement(): {
+        tag: string;
+        attrs: {};
+    };
+    getUserElement(): null;
+    parser(node: any): {
+        duration: number;
+        setAt: Date;
+    } | undefined;
+}
+//# sourceMappingURL=USyncDisappearingModeProtocol.d.ts.map

package/lib/WAUSync/Protocols/USyncDisappearingModeProtocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"USyncDisappearingModeProtocol.d.ts","sourceRoot":"","sources":["../../../src/WAUSync/Protocols/USyncDisappearingModeProtocol.js"],"names":[],"mappings":"AACA;IAEQ,aAA+B;IAEnC;;;MAKC;IACD,uBAEC;IACD;;;kBAUC;CACJ"}

package/lib/WAUSync/Protocols/USyncDisappearingModeProtocol.js

@@ -0,0 +1,27 @@
+import { assertNodeErrorFree } from '../../WABinary/index.js';
+export class USyncDisappearingModeProtocol {
+    constructor() {
+        this.name = 'disappearing_mode';
+    }
+    getQueryElement() {
+        return {
+            tag: 'disappearing_mode',
+            attrs: {}
+        };
+    }
+    getUserElement() {
+        return null;
+    }
+    parser(node) {
+        if (node.tag === 'disappearing_mode') {
+            assertNodeErrorFree(node);
+            const duration = +node?.attrs.duration;
+            const setAt = new Date(+(node?.attrs.t || 0) * 1000);
+            return {
+                duration,
+                setAt
+            };
+        }
+    }
+}
+//# sourceMappingURL=USyncDisappearingModeProtocol.js.map

package/lib/WAUSync/Protocols/USyncDisappearingModeProtocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"USyncDisappearingModeProtocol.js","sourceRoot":"","sources":["../../../src/WAUSync/Protocols/USyncDisappearingModeProtocol.js"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,MAAM,OAAO,6BAA6B;IACtC;QACI,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;IACpC,CAAC;IACD,eAAe;QACX,OAAO;YACH,GAAG,EAAE,mBAAmB;YACxB,KAAK,EAAE,EAAE;SACZ,CAAC;IACN,CAAC;IACD,cAAc;QACV,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,CAAC,IAAI;QACP,IAAI,IAAI,CAAC,GAAG,KAAK,mBAAmB,EAAE,CAAC;YACnC,mBAAmB,CAAC,IAAI,CAAC,CAAC;YAC1B,MAAM,QAAQ,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC;YACvC,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;YACrD,OAAO;gBACH,QAAQ;gBACR,KAAK;aACR,CAAC;QACN,CAAC;IACL,CAAC;CACJ"}

package/lib/WAUSync/Protocols/USyncFeatureProtocol.d.ts

@@ -0,0 +1,9 @@
+export const USYNC_FEATURES: string[];
+export class USyncFeatureProtocol {
+    constructor(features?: string[]);
+    name: string;
+    features: string[];
+    getQueryElement(): any;
+    getUserElement(): null;
+    parser(node: any): Record<string, any> | null;
+}

package/lib/WAUSync/Protocols/USyncFeatureProtocol.js

@@ -0,0 +1,70 @@
+import { assertNodeErrorFree, getBinaryNodeChild, getBinaryNodeChildren } from '../../WABinary/index.js';
+// Device feature flags that can be queried, ported from WhatsApp Web's
+// WAWebUsyncFeature module.
+export const USYNC_FEATURES = [
+	'document',
+	'encrypt',
+	'encrypt_blist',
+	'encrypt_contact',
+	'encrypt_group_gen2',
+	'encrypt_image',
+	'encrypt_location',
+	'encrypt_url',
+	'encrypt_v2',
+	'voip',
+	'voip_legacy',
+	'multi_agent',
+	'bot_eligible'
+]
+export class USyncFeatureProtocol {
+	/**
+	 * @param {string[]} [features] feature names to query (defaults to all known)
+	 */
+	constructor(features) {
+		this.name = 'feature'
+		this.features = features && features.length ? features : USYNC_FEATURES
+	}
+	getQueryElement() {
+		return {
+			tag: 'feature',
+			attrs: {},
+			content: this.features.map(feature => ({ tag: feature, attrs: {} }))
+		}
+	}
+	getUserElement() {
+		return null
+	}
+	parser(node) {
+		if (node.tag !== 'feature') {
+			return null
+		}
+		const errorNode = getBinaryNodeChild(node, 'error')
+		if (errorNode) {
+			return {
+				errorCode: errorNode.attrs?.code ? +errorNode.attrs.code : undefined,
+				errorText: errorNode.attrs?.text
+			}
+		}
+		const CAMEL_MAP = {
+			encrypt_v2: 'encryptV2',
+			voip_legacy: 'voipLegacy',
+			multi_agent: 'multiAgent',
+			bot_eligible: 'botEligible',
+			encrypt_blist: 'encryptBlist',
+			encrypt_contact: 'encryptContact',
+			encrypt_group_gen2: 'encryptGroupGen2',
+			encrypt_image: 'encryptImage',
+			encrypt_location: 'encryptLocation',
+			encrypt_url: 'encryptUrl'
+		}
+		const features = {}
+		const children = Array.isArray(node.content) ? node.content : []
+		for (const child of children) {
+			if (child?.attrs && child.attrs.value !== undefined) {
+				const key = CAMEL_MAP[child.tag] || child.tag
+				features[key] = child.attrs.value
+			}
+		}
+		return features
+	}
+}

package/lib/WAUSync/Protocols/USyncPictureProtocol.d.ts

@@ -0,0 +1,12 @@
+export class USyncPictureProtocol {
+    constructor(type?: 'image' | 'preview');
+    name: string;
+    type: string;
+    getQueryElement(): any;
+    getUserElement(user: any): any;
+    parser(node: any): {
+        id: string | null;
+        directPath: string | null;
+        hash: string | null;
+    } | null;
+}

package/lib/WAUSync/Protocols/USyncPictureProtocol.js

@@ -0,0 +1,28 @@
+import { assertNodeErrorFree, getBinaryNodeChild, getBinaryNodeChildren } from '../../WABinary/index.js';
+export class USyncPictureProtocol {
+	constructor(type = 'image') {
+		this.name = 'picture'
+		// "image" for full resolution, "preview" for thumbnail
+		this.type = type
+	}
+	getQueryElement() {
+		return {
+			tag: 'picture',
+			attrs: { type: this.type }
+		}
+	}
+	getUserElement(user) {
+		const attrs = {}
+		if (user.pictureId != null) attrs.id = String(user.pictureId)
+		return Object.keys(attrs).length > 0 ? { tag: 'picture', attrs } : null
+	}
+	parser(node) {
+		if (node.tag !== 'picture') return null
+		assertNodeErrorFree(node)
+		const id = node.attrs?.id ?? null
+		const directPath = node.attrs?.direct_path ?? null
+		const hash = node.attrs?.hash ?? null
+		if (!id && !directPath) return null
+		return { id, directPath, hash }
+	}
+}