@enbox/dwn-sdk-js 0.0.2 → 0.0.3

package/dist/types/tests/interfaces/messagess-query.spec.d.ts.map

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

package/dist/types/tests/scenarios/messages-query.spec.d.ts

@@ -1,2 +0,0 @@
-export declare function testMessagesQueryScenarios(): void;
-//# sourceMappingURL=messages-query.spec.d.ts.map

package/dist/types/tests/scenarios/messages-query.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"messages-query.spec.d.ts","sourceRoot":"","sources":["../../../../tests/scenarios/messages-query.spec.ts"],"names":[],"mappings":"AAmBA,wBAAgB,0BAA0B,IAAI,IAAI,CAqcjD"}

package/src/event-log/event-log-level.ts

@@ -1,72 +0,0 @@
-import type { EventLog } from '../types/event-log.js';
-import type { EventStream } from '../types/subscriptions.js';
-import type { ULIDFactory } from 'ulidx';
-import type { Filter, KeyValues, PaginationCursor } from '../types/query-types.js';
-
-import { createLevelDatabase } from '../store/level-wrapper.js';
-import { IndexLevel } from '../store/index-level.js';
-import { monotonicFactory } from 'ulidx';
-
-export type EventLogLevelConfig = {
- /**
-   * must be a directory path (relative or absolute) where
-   *  LevelDB will store its files, or in browsers, the name of the
-   * {@link https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase IDBDatabase} to be opened.
-  */
-  location?: string,
-  createLevelDatabase?: typeof createLevelDatabase,
-  eventStream?: EventStream,
-};
-
-export class EventLogLevel implements EventLog {
-  ulidFactory: ULIDFactory;
-  index: IndexLevel;
-
-  constructor(config?: EventLogLevelConfig) {
-    this.index = new IndexLevel({
-      location: 'EVENTLOG',
-      createLevelDatabase,
-      ...config,
-    });
-
-    this.ulidFactory = monotonicFactory();
-  }
-
-  async open(): Promise<void> {
-    return this.index.open();
-  }
-
-  async close(): Promise<void> {
-    return this.index.close();
-  }
-
-  async clear(): Promise<void> {
-    return this.index.clear();
-  }
-
-  async append(tenant: string, messageCid: string, indexes: KeyValues): Promise<void> {
-    const watermark = this.ulidFactory();
-    await this.index.put(tenant, messageCid, { ...indexes, watermark });
-  }
-
-  async queryEvents(tenant: string, filters: Filter[], cursor?: PaginationCursor): Promise<{ events: string[], cursor?: PaginationCursor }> {
-    const results = await this.index.query(tenant, filters, { sortProperty: 'watermark', cursor });
-    return {
-      events : results.map(({ messageCid }) => messageCid),
-      cursor : IndexLevel.createCursorFromLastArrayItem(results, 'watermark'),
-    };
-  }
-
-  async getEvents(tenant: string, cursor?: PaginationCursor): Promise<{ events: string[], cursor?: PaginationCursor }> {
-    return this.queryEvents(tenant, [], cursor);
-  }
-
-  async deleteEventsByCid(tenant: string, messageCids: Array<string>): Promise<void> {
-    const indexDeletePromises: Promise<void>[] = [];
-    for (const messageCid of messageCids) {
-      indexDeletePromises.push(this.index.delete(tenant, messageCid));
-    }
-
-    await Promise.all(indexDeletePromises);
-  }
-}

package/src/handlers/messages-query.ts

@@ -1,67 +0,0 @@
-import type { DidResolver } from '@enbox/dids';
-import type { EventLog } from '../types/event-log.js';
-import type { MessageStore } from '../types/message-store.js';
-import type { MethodHandler } from '../types/method-handler.js';
-import type { MessagesQueryMessage, MessagesQueryReply } from '../types/messages-types.js';
-
-import { authenticate } from '../core/auth.js';
-import { messageReplyFromError } from '../core/message-reply.js';
-import { Messages } from '../utils/messages.js';
-import { MessagesGrantAuthorization } from '../core/messages-grant-authorization.js';
-import { MessagesQuery } from '../interfaces/messages-query.js';
-import { PermissionsProtocol } from '../protocols/permissions.js';
-import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
-
-
-export class MessagesQueryHandler implements MethodHandler {
-
-  constructor(private didResolver: DidResolver, private messageStore: MessageStore, private eventLog: EventLog) { }
-
-  public async handle({
-    tenant,
-    message
-  }: {tenant: string, message: MessagesQueryMessage}): Promise<MessagesQueryReply> {
-    let messagesQuery: MessagesQuery;
-
-    try {
-      messagesQuery = await MessagesQuery.parse(message);
-    } catch (e) {
-      return messageReplyFromError(e, 400);
-    }
-
-    try {
-      await authenticate(message.authorization, this.didResolver);
-      await MessagesQueryHandler.authorizeMessagesQuery(tenant, messagesQuery, this.messageStore);
-    } catch (e) {
-      return messageReplyFromError(e, 401);
-    }
-
-    // an empty array of filters means no filtering and all events are returned
-    const eventFilters = Messages.convertFilters(message.descriptor.filters);
-    const { events, cursor } = await this.eventLog.queryEvents(tenant, eventFilters, message.descriptor.cursor);
-
-    return {
-      status  : { code: 200, detail: 'OK' },
-      entries : events,
-      cursor
-    };
-  }
-
-  private static async authorizeMessagesQuery(tenant: string, messagesQuery: MessagesQuery, messageStore: MessageStore): Promise<void> {
-    // if `MessagesQuery` author is the same as the target tenant, we can directly grant access
-    if (messagesQuery.author === tenant) {
-      return;
-    } else if (messagesQuery.author !== undefined && messagesQuery.signaturePayload!.permissionGrantId !== undefined) {
-      const permissionGrant = await PermissionsProtocol.fetchGrant(tenant, messageStore, messagesQuery.signaturePayload!.permissionGrantId);
-      await MessagesGrantAuthorization.authorizeQueryOrSubscribe({
-        incomingMessage : messagesQuery.message,
-        expectedGrantor : tenant,
-        expectedGrantee : messagesQuery.author,
-        permissionGrant,
-        messageStore
-      });
-    } else {
-      throw new DwnError(DwnErrorCode.MessagesQueryAuthorizationFailed, 'message failed authorization');
-    }
-  }
-}

package/src/interfaces/messages-query.ts

@@ -1,60 +0,0 @@
-import type { PaginationCursor } from '../types/query-types.js';
-import type { Signer } from '../types/signer.js';
-import type { MessagesFilter, MessagesQueryDescriptor, MessagesQueryMessage } from '../types/messages-types.js';
-
-import { AbstractMessage } from '../core/abstract-message.js';
-import { Message } from '../core/message.js';
-import { Messages } from '../utils/messages.js';
-import { removeUndefinedProperties } from '../utils/object.js';
-import { Time } from '../utils/time.js';
-import { validateProtocolUrlNormalized } from '../utils/url.js';
-import { DwnInterfaceName, DwnMethodName } from '../enums/dwn-interface-method.js';
-
-export type MessagesQueryOptions = {
-  signer: Signer;
-  filters?: MessagesFilter[];
-  cursor?: PaginationCursor;
-  messageTimestamp?: string;
-  permissionGrantId?: string;
-};
-
-export class MessagesQuery extends AbstractMessage<MessagesQueryMessage>{
-
-  public static async parse(message: MessagesQueryMessage): Promise<MessagesQuery> {
-    Message.validateJsonSchema(message);
-    await Message.validateSignatureStructure(message.authorization.signature, message.descriptor);
-
-    for (const filter of message.descriptor.filters) {
-      if ('protocol' in filter && filter.protocol !== undefined) {
-        validateProtocolUrlNormalized(filter.protocol);
-      }
-    }
-
-    return new MessagesQuery(message);
-  }
-
-  public static async create(options: MessagesQueryOptions): Promise<MessagesQuery> {
-    const descriptor: MessagesQueryDescriptor = {
-      interface        : DwnInterfaceName.Messages,
-      method           : DwnMethodName.Query,
-      filters          : options.filters ? Messages.normalizeFilters(options.filters) : [],
-      messageTimestamp : options.messageTimestamp ?? Time.getCurrentTimestamp(),
-      cursor           : options.cursor,
-    };
-
-    removeUndefinedProperties(descriptor);
-
-    const { permissionGrantId, signer } = options;
-    const authorization = await Message.createAuthorization({
-      descriptor,
-      signer,
-      permissionGrantId
-    });
-
-    const message = { descriptor, authorization };
-
-    Message.validateJsonSchema(message);
-
-    return new MessagesQuery(message);
-  }
-}

package/src/types/event-log.ts

@@ -1,52 +0,0 @@
-import type { Filter, KeyValues, PaginationCursor } from './query-types.js';
-
-export interface EventLog {
- /**
-  * opens a connection to the underlying store
-  */
-  open(): Promise<void>;
-
-  /**
-   * closes the connection to the underlying store
-   */
-  close(): Promise<void>;
-
-  /**
-   * adds an event to a tenant's event log
-   * @param tenant - the tenant's DID
-   * @param messageCid - the CID of the message
-   * @param indexes - (key-value pairs) to be included as part of indexing this event.
-   */
-  append(tenant: string, messageCid: string, indexes: KeyValues): Promise<void>
-
-  /**
-   * Retrieves all of a tenant's events that occurred after the cursor provided.
-   * If no cursor is provided, all events for a given tenant will be returned.
-   *
-   * The cursor is a messageCid.
-   *
-   * Returns an array of messageCids that represent the events.
-   */
-  getEvents(tenant: string, cursor?: PaginationCursor): Promise<{ events: string[], cursor?: PaginationCursor }>
-
-  /**
-   * retrieves a filtered set of events that occurred after a the cursor provided, accepts multiple filters.
-   *
-   * If no cursor is provided, all events for a given tenant and filter combo will be returned.
-   * The cursor is a messageCid.
-   *
-   * Returns an array of messageCids that represent the events.
-   */
-  queryEvents(tenant: string, filters: Filter[], cursor?: PaginationCursor): Promise<{ events: string[], cursor?: PaginationCursor }>
-
-  /**
-   * deletes any events that have any of the messageCids provided
-   * @returns {Promise<number>} the number of events deleted
-   */
-  deleteEventsByCid(tenant: string, messageCids: Array<string>): Promise<void>
-
-  /**
-   * Clears the entire store. Mainly used for cleaning up in test environment.
-   */
-  clear(): Promise<void>;
-}