@enbox/dwn-sdk-js 0.3.5 → 0.3.6

package/src/dwn.ts

@@ -33,6 +33,18 @@ import { StorageController } from './store/storage-controller.js';
 import { DidDht, DidJwk, DidKey, DidResolverCacheMemory, DidWeb, UniversalResolver } from '@enbox/dids';
 import { DwnInterfaceName, DwnMethodName } from './enums/dwn-interface-method.js';
 
+/**
+ * Structural shape for `DidResolver` implementations that expose
+ * optional lifecycle hooks (e.g. cache-backed resolvers that need to
+ * open/close a store). The base `DidResolver` interface in
+ * `@enbox/dids` doesn't declare these methods, so `Dwn.open()` /
+ * `Dwn.close()` probe via this narrowly-typed cast (no `any`).
+ */
+type LifecycleResolver = {
+  open: () => Promise<void>;
+  close: () => Promise<void>;
+};
+
 export class Dwn {
   private readonly methodHandlers: { [key:string]: MethodHandler };
   private readonly didResolver: DidResolver;
@@ -125,8 +137,12 @@ export class Dwn {
    */
   public async open(): Promise<void> {
     // Open the resolver's cache if the DWN owns it (created via defaults).
-    if (this.ownsResolver && typeof (this.didResolver as any).open === 'function') {
-      await (this.didResolver as any).open();
+    // The base `DidResolver` interface in `@enbox/dids` doesn't declare
+    // optional lifecycle hooks; cache-backed implementations expose them
+    // structurally. Narrowly-typed probe (no `any`).
+    const lifecycleResolver = this.didResolver as Partial<LifecycleResolver>;
+    if (this.ownsResolver && typeof lifecycleResolver.open === 'function') {
+      await lifecycleResolver.open();
     }
 
     await this.messageStore.open();
@@ -146,8 +162,9 @@ export class Dwn {
     await this.stateIndex.close();
 
     // Close the resolver's cache if the DWN owns it.
-    if (this.ownsResolver && typeof (this.didResolver as any).close === 'function') {
-      await (this.didResolver as any).close();
+    const lifecycleResolver = this.didResolver as Partial<LifecycleResolver>;
+    if (this.ownsResolver && typeof lifecycleResolver.close === 'function') {
+      await lifecycleResolver.close();
     }
   }
 

package/src/handlers/protocols-query.ts

@@ -5,7 +5,7 @@ import { authenticate } from '../core/auth.js';
 import { DwnErrorCode } from '../core/dwn-error.js';
 import { messageReplyFromError } from '../core/message-reply.js';
 import { ProtocolsQuery } from '../interfaces/protocols-query.js';
-import { removeUndefinedProperties } from '../utils/object.js';
+import { removeUndefinedProperties } from '@enbox/common';
 
 import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
 

package/src/interfaces/messages-subscribe.ts

@@ -5,7 +5,7 @@ import type { MessagesSubscribeDescriptor, MessagesSubscribeMessage } from '../t
 
 import { AbstractMessage } from '../core/abstract-message.js';
 import { Message } from '../core/message.js';
-import { removeUndefinedProperties } from '../utils/object.js';
+import { removeUndefinedProperties } from '@enbox/common';
 import { Time } from '../utils/time.js';
 import { validateProtocolUrlNormalized } from '../utils/url.js';
 import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';

package/src/interfaces/messages-sync.ts

@@ -3,7 +3,7 @@ import type { MessagesSyncAction, MessagesSyncDescriptor, MessagesSyncMessage }
 
 import { AbstractMessage } from '../core/abstract-message.js';
 import { Message } from '../core/message.js';
-import { removeUndefinedProperties } from '../utils/object.js';
+import { removeUndefinedProperties } from '@enbox/common';
 import { Time } from '../utils/time.js';
 import { validateProtocolUrlNormalized } from '../utils/url.js';
 import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';

package/src/interfaces/protocols-query.ts

@@ -7,7 +7,7 @@ import { AbstractMessage } from '../core/abstract-message.js';
 import { Message } from '../core/message.js';
 import { PermissionsProtocol } from '../protocols/permissions.js';
 import { ProtocolsGrantAuthorization } from '../core/protocols-grant-authorization.js';
-import { removeUndefinedProperties } from '../utils/object.js';
+import { removeUndefinedProperties } from '@enbox/common';
 import { Time } from '../utils/time.js';
 import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
 import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';

package/src/interfaces/records-count.ts

@@ -7,7 +7,7 @@ import { Message } from '../core/message.js';
 import { PermissionGrant } from '../protocols/permission-grant.js';
 import { Records } from '../utils/records.js';
 import { RecordsGrantAuthorization } from '../core/records-grant-authorization.js';
-import { removeUndefinedProperties } from '../utils/object.js';
+import { removeUndefinedProperties } from '@enbox/common';
 import { Time } from '../utils/time.js';
 import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
 import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';

package/src/interfaces/records-delete.ts

@@ -8,7 +8,7 @@ import { Message } from '../core/message.js';
 import { PermissionGrant } from '../protocols/permission-grant.js';
 import { Records } from '../utils/records.js';
 import { RecordsGrantAuthorization } from '../core/records-grant-authorization.js';
-import { removeUndefinedProperties } from '../utils/object.js';
+import { removeUndefinedProperties } from '@enbox/common';
 import { Time } from '../utils/time.js';
 import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
 

package/src/interfaces/records-query.ts

@@ -9,7 +9,7 @@ import { Message } from '../core/message.js';
 import { PermissionGrant } from '../protocols/permission-grant.js';
 import { Records } from '../utils/records.js';
 import { RecordsGrantAuthorization } from '../core/records-grant-authorization.js';
-import { removeUndefinedProperties } from '../utils/object.js';
+import { removeUndefinedProperties } from '@enbox/common';
 import { Time } from '../utils/time.js';
 import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
 import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';

package/src/interfaces/records-read.ts

@@ -8,7 +8,7 @@ import { Message } from '../core/message.js';
 import { PermissionGrant } from '../protocols/permission-grant.js';
 import { Records } from '../utils/records.js';
 import { RecordsGrantAuthorization } from '../core/records-grant-authorization.js';
-import { removeUndefinedProperties } from '../utils/object.js';
+import { removeUndefinedProperties } from '@enbox/common';
 import { Time } from '../utils/time.js';
 import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
 import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';

package/src/interfaces/records-subscribe.ts

@@ -9,7 +9,7 @@ import { Message } from '../core/message.js';
 import { PermissionGrant } from '../protocols/permission-grant.js';
 import { Records } from '../utils/records.js';
 import { RecordsGrantAuthorization } from '../core/records-grant-authorization.js';
-import { removeUndefinedProperties } from '../utils/object.js';
+import { removeUndefinedProperties } from '@enbox/common';
 import { Time } from '../utils/time.js';
 import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
 import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';

package/src/interfaces/records-write-signing.ts

@@ -8,7 +8,7 @@ import { Encoder } from '../utils/encoder.js';
 import { Encryption } from '../utils/encryption.js';
 import { GeneralJwsBuilder } from '../jose/jws/general/builder.js';
 import { Jws } from '../utils/jws.js';
-import { removeUndefinedProperties } from '../utils/object.js';
+import { removeUndefinedProperties } from '@enbox/common';
 import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
 
 /**

package/src/interfaces/records-write.ts

@@ -21,7 +21,7 @@ import { Message } from '../core/message.js';
 import { PermissionGrant } from '../protocols/permission-grant.js';
 import { Records } from '../utils/records.js';
 import { RecordsGrantAuthorization } from '../core/records-grant-authorization.js';
-import { removeUndefinedProperties } from '../utils/object.js';
+import { removeUndefinedProperties } from '@enbox/common';
 import { Time } from '../utils/time.js';
 import {
   createAttestation,
@@ -225,7 +225,7 @@ export class RecordsWrite implements MessageInterface<RecordsWriteMessage> {
     this._message = message;
 
     if (message.authorization !== undefined) {
-      this._author = Message.getAuthor(message as RecordsWriteMessage);
+      this._author = Message.getAuthor(message);
 
       this._signaturePayload = Jws.decodePlainObjectPayload(message.authorization.signature);
 

package/src/store/index-level.ts

@@ -1,7 +1,7 @@
 import type { EqualFilter, Filter, KeyValues, PaginationCursor, QueryOptions, RangeFilter } from '../types/query-types.js';
 import type { LevelWrapperBatchOperation, LevelWrapperIteratorOptions, } from './level-wrapper.js';
 
-import { isEmptyObject } from '../utils/object.js';
+import { isEmptyObject } from '@enbox/common';
 import { lexicographicalCompare } from '../utils/string.js';
 import { SortDirection } from '../types/query-types.js';
 import {

package/src/utils/messages.ts

@@ -4,7 +4,7 @@ import type { MessagesFilter } from '../types/messages-types.js';
 
 import { FilterUtility } from './filter.js';
 import { normalizeProtocolUrl } from './url.js';
-import { isEmptyObject, removeUndefinedProperties } from './object.js';
+import { isEmptyObject, removeUndefinedProperties } from '@enbox/common';
 
 
 /**

package/src/utils/records.ts

@@ -12,7 +12,7 @@ import { FilterUtility } from './filter.js';
 import { Jws } from './jws.js';
 import { Message } from '../core/message.js';
 import { PermissionGrant } from '../protocols/permission-grant.js';
-import { removeUndefinedProperties } from './object.js';
+import { removeUndefinedProperties } from '@enbox/common';
 import { SortDirection } from '../types/query-types.js';
 import { X25519 } from '@enbox/crypto';
 import { DwnError, DwnErrorCode } from '../core/dwn-error.js';

package/src/utils/time.ts

@@ -1,3 +1,4 @@
+import { sleep } from '@enbox/common';
 import { Temporal } from '@js-temporal/polyfill';
 import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
 
@@ -5,21 +6,15 @@ import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
  * Time related utilities.
  */
 export class Time {
-  /**
-   * sleeps for the desired duration
-   * @param durationInMillisecond the desired amount of sleep time
-   * @returns when the provided duration has passed
-   */
-  public static async sleep(durationInMillisecond: number): Promise<void> {
-    return new Promise(resolve => setTimeout(resolve, durationInMillisecond));
-  }
-
   /**
    * We must sleep for at least 2ms to avoid timestamp collisions during testing.
    * https://github.com/enboxorg/enbox/issues/481
+   *
+   * For arbitrary-duration sleeps, use `sleep` from `@enbox/common`
+   * directly — this class only retains the DWN-specific minimum.
    */
   public static async minimalSleep(): Promise<void> {
-    await Time.sleep(2);
+    await sleep(2);
   }
 
   /**

package/dist/esm/src/utils/object.js

@@ -1,37 +0,0 @@
-/**
- * Checks whether the given object has any properties.
- */
-export function isEmptyObject(obj) {
-    if (typeof (obj) !== 'object') {
-        return false;
-    }
-    return Object.keys(obj).length === 0;
-}
-/**
- * Recursively removes all properties with an empty object or array as its value from the given object.
- */
-export function removeEmptyObjects(obj) {
-    Object.keys(obj).forEach(key => {
-        if (typeof (obj[key]) === 'object') {
-            // recursive remove empty object or array properties in nested objects
-            removeEmptyObjects(obj[key]);
-        }
-        if (isEmptyObject(obj[key])) {
-            delete obj[key];
-        }
-    });
-}
-/**
- * Recursively removes all properties with `undefined` as its value from the given object.
- */
-export function removeUndefinedProperties(obj) {
-    Object.keys(obj).forEach(key => {
-        if (obj[key] === undefined) {
-            delete obj[key];
-        }
-        else if (typeof (obj[key]) === 'object') {
-            removeUndefinedProperties(obj[key]); // recursive remove `undefined` properties in nested objects
-        }
-    });
-}
-//# sourceMappingURL=object.js.map

package/dist/esm/src/utils/object.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"object.js","sourceRoot":"","sources":["../../../../src/utils/object.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,GAAY;IACxC,IAAI,OAAM,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,GAAa,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;AACjD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAA4B;IAC7D,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QAC7B,IAAI,OAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;YAClC,sEAAsE;YACtE,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAA4B,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YAC5B,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,yBAAyB,CAAC,GAA4B;IACpE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QAC7B,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;QAClB,CAAC;aAAM,IAAI,OAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;YACzC,yBAAyB,CAAC,GAAG,CAAC,GAAG,CAA4B,CAAC,CAAC,CAAC,4DAA4D;QAC9H,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/esm/tests/utils/object.spec.js

@@ -1,36 +0,0 @@
-import { describe, expect, it } from 'bun:test';
-import { removeEmptyObjects, removeUndefinedProperties } from '../../src/utils/object.js';
-describe('Object', () => {
-    describe('removeUndefinedProperties', () => {
-        it('should remove all `undefined` properties of a nested object', () => {
-            const mockObject = {
-                a: true,
-                b: undefined,
-                c: {
-                    a: 0,
-                    b: undefined,
-                }
-            };
-            const expectedResult = {
-                a: true,
-                c: {
-                    a: 0
-                }
-            };
-            removeUndefinedProperties(mockObject);
-            expect(mockObject).toEqual(expectedResult);
-        });
-    });
-    describe('removeEmptyObjects', () => {
-        it('should remove all empty objects', () => {
-            const obj = {
-                foo: {},
-                bar: { baz: {} },
-                buzz: 'hello'
-            };
-            removeEmptyObjects(obj);
-            expect(obj).toEqual({ buzz: 'hello' });
-        });
-    });
-});
-//# sourceMappingURL=object.spec.js.map

package/dist/esm/tests/utils/object.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"object.spec.js","sourceRoot":"","sources":["../../../../tests/utils/object.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAE1F,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACzC,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;YACrE,MAAM,UAAU,GAAG;gBACjB,CAAC,EAAG,IAAI;gBACR,CAAC,EAAG,SAAS;gBACb,CAAC,EAAG;oBACF,CAAC,EAAG,CAAC;oBACL,CAAC,EAAG,SAAS;iBACd;aACF,CAAC;YACF,MAAM,cAAc,GAAG;gBACrB,CAAC,EAAG,IAAI;gBACR,CAAC,EAAG;oBACF,CAAC,EAAE,CAAC;iBACL;aACF,CAAC;YAEF,yBAAyB,CAAC,UAAU,CAAC,CAAC;YAEtC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;YACzC,MAAM,GAAG,GAAG;gBACV,GAAG,EAAI,EAAE;gBACT,GAAG,EAAI,EAAE,GAAG,EAAE,EAAE,EAAE;gBAClB,IAAI,EAAG,OAAO;aACf,CAAC;YACF,kBAAkB,CAAC,GAAG,CAAC,CAAC;YAExB,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/types/src/utils/object.d.ts

@@ -1,13 +0,0 @@
-/**
- * Checks whether the given object has any properties.
- */
-export declare function isEmptyObject(obj: unknown): boolean;
-/**
- * Recursively removes all properties with an empty object or array as its value from the given object.
- */
-export declare function removeEmptyObjects(obj: Record<string, unknown>): void;
-/**
- * Recursively removes all properties with `undefined` as its value from the given object.
- */
-export declare function removeUndefinedProperties(obj: Record<string, unknown>): void;
-//# sourceMappingURL=object.d.ts.map

package/dist/types/src/utils/object.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../../../src/utils/object.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAMnD;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAWrE;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAQ5E"}

package/dist/types/tests/utils/object.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=object.spec.d.ts.map

package/dist/types/tests/utils/object.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"object.spec.d.ts","sourceRoot":"","sources":["../../../../tests/utils/object.spec.ts"],"names":[],"mappings":""}

package/src/utils/object.ts

@@ -1,39 +0,0 @@
-/**
- * Checks whether the given object has any properties.
- */
-export function isEmptyObject(obj: unknown): boolean {
-  if (typeof(obj) !== 'object') {
-    return false;
-  }
-
-  return Object.keys(obj as object).length === 0;
-}
-
-/**
- * Recursively removes all properties with an empty object or array as its value from the given object.
- */
-export function removeEmptyObjects(obj: Record<string, unknown>): void {
-  Object.keys(obj).forEach(key => {
-    if (typeof(obj[key]) === 'object') {
-      // recursive remove empty object or array properties in nested objects
-      removeEmptyObjects(obj[key] as Record<string, unknown>);
-    }
-
-    if (isEmptyObject(obj[key])) {
-      delete obj[key];
-    }
-  });
-}
-
-/**
- * Recursively removes all properties with `undefined` as its value from the given object.
- */
-export function removeUndefinedProperties(obj: Record<string, unknown>): void {
-  Object.keys(obj).forEach(key => {
-    if (obj[key] === undefined) {
-      delete obj[key];
-    } else if (typeof(obj[key]) === 'object') {
-      removeUndefinedProperties(obj[key] as Record<string, unknown>); // recursive remove `undefined` properties in nested objects
-    }
-  });
-}