Fix Moments model and fetchs to Compass (#22)

* Fix Moments model and fetch to Compass

* Remove unnecessary Moments stuff and fix typos

* Bump package version

examples/moments/backend/src/methods/create_moment.ts

@@ -1,5 +1,5 @@
 /* eslint-disable max-statements */
-import { MomentsClient, createMomentInput } from '@poap-xyz/moments';
+import { MomentsClient, CreateMomentInput } from '@poap-xyz/moments';
 import fs from 'fs';
 import mime from 'mime';
 
@@ -12,7 +12,7 @@ export const create_moment = async (client: MomentsClient): Promise<void> => {
     return;
   }
 
-  const input: createMomentInput = {
+  const input: CreateMomentInput = {
     dropId: 110148,
     /**
      * The Token ID related to the moment (Optional)

packages/drops/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poap-xyz/drops",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "description": "Drops module for the poap.js library",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",

packages/moments/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poap-xyz/moments",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "description": "Moments module for the poap.js library",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",

packages/moments/src/MomentsClient.ts

@@ -1,6 +1,6 @@
 import { PoapMomentsApi, CompassProvider } from '@poap-xyz/providers';
 import { PaginatedResult, nextCursor } from '@poap-xyz/utils';
-import { createMomentInput, FetchMomentsInput } from './types';
+import { CreateMomentInput, FetchMomentsInput } from './types';
 import { Moment } from './domain/Moment';
 import {
   createBetweenFilter,
@@ -9,16 +9,19 @@ import {
   creatEqFilter,
   filterUndefinedProperties,
 } from './queries/utils';
-import { MomentsQueryResponse, PAGINATED_MOMENTS_QUERY } from './queries';
-import { MediaStatus } from './domain/MediaStatus';
+import {
+  MomentResponse,
+  MomentsQueryResponse,
+  PAGINATED_MOMENTS_QUERY,
+} from './queries';
 
 export class MomentsClient {
   constructor(
     private PoapMomentsApi: PoapMomentsApi,
     private CompassProvider: CompassProvider,
   ) {}
 
-  async createMoment(input: createMomentInput): Promise<Moment> {
+  async createMoment(input: CreateMomentInput): Promise<Moment> {
     const { url, key } = await this.PoapMomentsApi.getSignedUrl();
     await this.PoapMomentsApi.uploadFile(input.file, url, input.fileType);
     await this.PoapMomentsApi.waitForMediaProcessing(key, input.timeOut);
@@ -33,7 +36,8 @@ export class MomentsClient {
       response.author,
       response.createdOn,
       response.dropId,
-      response.media,
+      // We will always have a gateway because we wait for the media to be processed
+      response.media.gateways!,
       response.tokenId,
     );
   }
@@ -75,27 +79,26 @@ export class MomentsClient {
       variables,
     );
 
-    const moments_response: Moment[] = response.data.moments.map((moment) => {
-      return new Moment(
-        moment.id,
-        moment.author,
-        new Date(moment.created_on),
-        moment.drop_id,
-        {
-          key: moment.media_key,
-          mimeType: moment.mime_type,
-          status: MediaStatus.PROCESSED,
-          hash: moment.media_hash,
-        },
-        moment.token_id,
-      );
-    });
+    const momentsResponse: Moment[] = response.data.moments.map(
+      this.getMomentFromMomentResponse,
+    );
 
     const result = new PaginatedResult<Moment>(
-      moments_response,
-      nextCursor(moments_response.length, limit, offset),
+      momentsResponse,
+      nextCursor(momentsResponse.length, limit, offset),
     );
 
     return result;
   }
+
+  private getMomentFromMomentResponse(momentResponse: MomentResponse): Moment {
+    return new Moment(
+      momentResponse.id,
+      momentResponse.author,
+      new Date(momentResponse.created_on),
+      momentResponse.drop_id,
+      momentResponse.gateways,
+      momentResponse.token_id,
+    );
+  }
 }

packages/moments/src/domain/Moment.ts

@@ -1,5 +1,3 @@
-import { Media } from './Media';
-
 /**
  * Represents a moment.
  */
@@ -19,12 +17,6 @@ export class Moment {
    */
   public readonly createdOn: Date;
 
-  /**
-   * The media file associated with the moment.
-   * @type {Media}
-   */
-  public readonly media: Media;
-
   /**
    * The drop ID related to the moment.
    */
@@ -35,19 +27,24 @@ export class Moment {
    */
   public readonly tokenId?: number;
 
+  /**
+   * Indicates an array of gateways that the media file is stored on.
+   */
+  public readonly gateways: string[];
+
   constructor(
     id: string,
     author: string,
     createdOn: Date,
     dropId: number,
-    media: Media,
+    gateways: string[],
     tokenId?: number,
   ) {
     this.id = id;
     this.author = author;
     this.createdOn = createdOn;
     this.dropId = dropId;
     this.tokenId = tokenId;
-    this.media = media;
+    this.gateways = gateways;
   }
 }

packages/moments/src/index.ts

@@ -1,3 +1,3 @@
-export { createMomentInput, FetchMomentsInput } from './types/input';
+export { CreateMomentInput, FetchMomentsInput } from './types/input';
 export { Moment } from './domain/Moment';
 export { MomentsClient } from './MomentsClient';

packages/moments/src/queries/PaginatedMoments.ts

@@ -10,11 +10,8 @@ export const PAGINATED_MOMENTS_QUERY = `
       created_on
       drop_id
       id
-      location
-      media_gateways
-      media_hash
+      gateways
       media_key
-      mime_type
       token_id
     }
   }
@@ -25,11 +22,8 @@ export interface MomentResponse {
   created_on: string;
   drop_id: number;
   id: string;
-  location: string;
-  media_gateways: string[];
-  media_hash: string;
+  gateways: string[];
   media_key: string;
-  mime_type: string;
   token_id: number;
 }
 

packages/moments/src/types/input.ts

@@ -8,7 +8,7 @@
  * @property {string} timeOut - The amount of time to wait until media is processed.
  * @property {string} fileType - The type of the file.
  */
-export interface createMomentInput {
+export interface CreateMomentInput {
   dropId: number;
   tokenId?: number;
   file: Buffer;

packages/providers/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poap-xyz/providers",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "description": "Providers module for the poap.js library",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",

packages/providers/src/core/PoapMomentsApi/PoapMomentsApi.ts

@@ -1,10 +1,10 @@
 import { InvalidMediaFileError } from './errors/InvalidMediaFileError';
-import { MediaStatus } from './constants';
 import { CreateMomentResponse } from '../../ports/MomentsApiProvider';
 import { CreateMomentInput } from '../../ports/MomentsApiProvider';
 import { MomentsApiProvider } from '../../ports';
 import { AuthenticationProvider } from '../../ports';
 import axios, { AxiosError } from 'axios';
+import { MediaStatus } from './Types/MediaStatus';
 
 const MOMENTS_BASE_URL = 'https://moments.poap.tech';
 

packages/providers/src/core/PoapMomentsApi/Types/MediaStatus.ts

@@ -0,0 +1,5 @@
+export enum MediaStatus {
+  INVALID = 'INVALID',
+  PROCESSED = 'PROCESSED',
+  IN_PROCESS = 'IN_PROCESS',
+}

packages/providers/src/ports/MomentsApiProvider/Types/CreateMomentResponse.ts

@@ -0,0 +1,30 @@
+export interface CreateMomentResponse {
+  id: string;
+
+  /**
+   * The author of the moment (for now only ETH accounts).
+   */
+  author: string;
+
+  /**
+   * When the moment was received on the API.
+   */
+  createdOn: Date;
+
+  /**
+   * The media file associated with the moment.
+   */
+  media: {
+    gateways: string[];
+  };
+
+  /**
+   * The drop ID related to the moment.
+   */
+  dropId: number;
+
+  /**
+   * The token ID related to the moment (optional).
+   */
+  tokenId?: number;
+}

packages/providers/src/ports/MomentsApiProvider/Types/index.ts

@@ -1,2 +1,2 @@
-export * from './input';
-export * from './response';
+export * from './CreateMomentInput';
+export * from './CreateMomentResponse';