[Moments] Rename medias to media

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

@@ -1,4 +1,4 @@
-import { MomentsClient, CreateMomentInput } from '@poap-xyz/moments';
+import { CreateMomentInput, MomentsClient } from '@poap-xyz/moments';
 import fs from 'fs';
 import mime from 'mime';
 
@@ -18,7 +18,7 @@ export const create_moment = async (client: MomentsClient): Promise<void> => {
      */
     tokenId: 6568008,
     author: '0x82AB2941Cf555CED5ad7Ed232a5B5f6083815FBC',
-    medias: [
+    media: [
       {
         fileBinary: fileBuffer,
         fileType: mimeType,

packages/drops/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poap-xyz/drops",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Drops module for the poap.js library",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",
@@ -29,7 +29,7 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@poap-xyz/providers": "0.3.0",
-    "@poap-xyz/utils": "0.3.0"
+    "@poap-xyz/providers": "0.4.0",
+    "@poap-xyz/utils": "0.4.0"
   }
 }

packages/moments/README.md

@@ -27,8 +27,8 @@ yarn add @poap-xyz/moments @poap-xyz/utils @poap-xyz/providers axio
 ## Usage
 
 ```javascript
-import { MomentsClient, CreateMomentInput, Moment } from '@poap-xyz/moments';
-import { PoapCompass, PoapMomentsApi, AuthenticationProviderHttp } from '@poap-xyz/providers';
+import {MomentsClient, CreateMomentInput, Moment} from '@poap-xyz/moments';
+import {PoapCompass, PoapMomentsApi, AuthenticationProviderHttp} from '@poap-xyz/providers';
 import fs from 'fs';
 
 // Set up the PoapMomentsApi with proper authentication
@@ -47,7 +47,7 @@ const client = new MomentsClient(
 const input: CreateMomentInput = {
     dropId: 110148,
     tokenId: 6568008, // Optional: The Token ID related to the moment
-    medias: [{
+    media: [{
         fileBinary: await fs.promises.readFile('src/assets/poap.png'),
         fileType: 'image/png',
     }],
@@ -63,16 +63,16 @@ const input: CreateMomentInput = {
 };
 const moment: Moment = await client.createMoment(input);
 ```
-Explanations for each step:
 
-| Step Name               | Explanation                                              |
-|-------------------------|----------------------------------------------------------|
-| `UPLOADING_MEDIA`       | The process of uploading media assets.                   |
-| `PROCESSING_MEDIA`      | The media assets are being processed after upload.       |
-| `PROCESSING_MEDIA_ERROR`| An error occurred during the media processing phase.     |
-| `UPLOADING_MOMENT`      | The process of uploading the moment's data.              |
-| `FINISHED`              | The entire operation of creating the moment is complete. |
+Explanations for each step:
 
+| Step Name                | Explanation                                              |
+|--------------------------|----------------------------------------------------------|
+| `UPLOADING_MEDIA`        | The process of uploading media assets.                   |
+| `PROCESSING_MEDIA`       | The media assets are being processed after upload.       |
+| `PROCESSING_MEDIA_ERROR` | An error occurred during the media processing phase.     |
+| `UPLOADING_MOMENT`       | The process of uploading the moment's data.              |
+| `FINISHED`               | The entire operation of creating the moment is complete. |
 
 ## Documentation
 

packages/moments/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poap-xyz/moments",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Moments module for the poap.js library",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",
@@ -26,8 +26,8 @@
     "build": "rollup -c --bundleConfigAsCjs"
   },
   "dependencies": {
-    "@poap-xyz/providers": "0.3.0",
-    "@poap-xyz/utils": "0.3.0",
+    "@poap-xyz/providers": "0.4.0",
+    "@poap-xyz/utils": "0.4.0",
     "uuid": "^9.0.0"
   },
   "engines": {

packages/moments/src/client/MomentsClient.spec.ts

@@ -50,7 +50,7 @@ describe('MomentsClient', () => {
       const inputs: CreateMomentInput = {
         dropId: DROP_ID,
         tokenId: TOKEN_ID,
-        medias: MEDIAS_TO_CREATE,
+        media: MEDIAS_TO_CREATE,
         author: AUTHOR,
         onStepUpdate,
         description: DESCRIPTION,

packages/moments/src/client/MomentsClient.ts

@@ -32,9 +32,9 @@ export class MomentsClient {
 
   public async createMoment(input: CreateMomentInput): Promise<Moment> {
     let mediaKeys: string[] = [];
-    if (input.medias && input.medias.length > 0) {
+    if (input.media && input.media.length > 0) {
       mediaKeys = await this.uploadMedias(
-        input.medias,
+        input.media,
         input.onStepUpdate,
         input.onFileUploadProgress,
         input.timeOut,
@@ -71,17 +71,17 @@ export class MomentsClient {
   }
 
   private async uploadMedias(
-    medias: CreateMedia[],
+    mediaArray: CreateMedia[],
     onStepUpdate?: (step: CreateSteps) => void | Promise<void>,
     onFileUploadProgress?: (progress: number) => void | Promise<void>,
     timeOut?: number,
   ): Promise<string[]> {
     void onStepUpdate?.(CreateSteps.UPLOADING_MEDIA);
     const mediaKeys: string[] = [];
-    const progressPerMedia = 1 / medias.length;
+    const progressPerMedia = 1 / mediaArray.length;
     let progress = 0;
 
-    for (const media of medias) {
+    for (const media of mediaArray) {
       const mediaOnFileUploadProgress = (mediaProgress: number): void => {
         const totalProgress = progressPerMedia * mediaProgress + progress;
         void onFileUploadProgress?.(totalProgress);

packages/moments/src/client/dtos/create/CreateInput.ts

@@ -11,7 +11,7 @@ import { CreateMedia } from './CreateMedia';
  * @property {string} timeOut - The amount of time to wait until media is processed.
  * @property {(step: CreateSteps) => void | Promise<void>} [onStepUpdate] - Optional callback function to be called when the step changes.
  * @property {(progress: number) => void | Promise<void>} [onFileProgress] - Optional callback function to be called when the file upload progress change - progress is a number between 0 and 1.
- * @property {CreateMedia[]} medias - The media to be uploaded.
+ * @property {CreateMedia[]} media - The media to be uploaded.
  */
 export interface CreateMomentInput {
   author: string;
@@ -21,5 +21,5 @@ export interface CreateMomentInput {
   timeOut?: number;
   onStepUpdate?: (step: CreateSteps) => void | Promise<void>;
   onFileUploadProgress?: (progress: number) => void | Promise<void>;
-  medias?: CreateMedia[];
+  media?: CreateMedia[];
 }

packages/poaps/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poap-xyz/poaps",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Poaps module for the poap.js library",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",
@@ -26,8 +26,8 @@
     "build": "rollup -c --bundleConfigAsCjs"
   },
   "dependencies": {
-    "@poap-xyz/providers": "0.3.0",
-    "@poap-xyz/utils": "0.3.0"
+    "@poap-xyz/providers": "0.4.0",
+    "@poap-xyz/utils": "0.4.0"
   },
   "engines": {
     "node": ">=18"

packages/providers/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poap-xyz/providers",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Providers module for the poap.js library",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",
@@ -26,7 +26,7 @@
     "build": "rollup -c --bundleConfigAsCjs"
   },
   "dependencies": {
-    "@poap-xyz/utils": "0.3.0",
+    "@poap-xyz/utils": "0.4.0",
     "axios": "^1.6.8",
     "lodash.chunk": "^4.2.0"
   },

packages/utils/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poap-xyz/utils",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Utils module for the poap.js library",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",

yarn.lock

@@ -884,8 +884,8 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@poap-xyz/drops@workspace:packages/drops"
   dependencies:
-    "@poap-xyz/providers": 0.3.0
-    "@poap-xyz/utils": 0.3.0
+    "@poap-xyz/providers": 0.4.0
+    "@poap-xyz/utils": 0.4.0
   languageName: unknown
   linkType: soft
 
@@ -901,8 +901,8 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@poap-xyz/moments@workspace:packages/moments"
   dependencies:
-    "@poap-xyz/providers": 0.3.0
-    "@poap-xyz/utils": 0.3.0
+    "@poap-xyz/providers": 0.4.0
+    "@poap-xyz/utils": 0.4.0
     "@types/uuid": ^9.0.2
     uuid: ^9.0.0
   languageName: unknown
@@ -912,24 +912,24 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@poap-xyz/poaps@workspace:packages/poaps"
   dependencies:
-    "@poap-xyz/providers": 0.3.0
-    "@poap-xyz/utils": 0.3.0
+    "@poap-xyz/providers": 0.4.0
+    "@poap-xyz/utils": 0.4.0
   languageName: unknown
   linkType: soft
 
-"@poap-xyz/providers@*, @poap-xyz/providers@0.3.0, @poap-xyz/providers@workspace:packages/providers":
+"@poap-xyz/providers@*, @poap-xyz/providers@0.4.0, @poap-xyz/providers@workspace:packages/providers":
   version: 0.0.0-use.local
   resolution: "@poap-xyz/providers@workspace:packages/providers"
   dependencies:
-    "@poap-xyz/utils": 0.3.0
+    "@poap-xyz/utils": 0.4.0
     axios: ^1.6.8
     axios-mock-adapter: ^1.21.4
     jest-fetch-mock: ^3.0.3
     lodash.chunk: ^4.2.0
   languageName: unknown
   linkType: soft
 
-"@poap-xyz/utils@*, @poap-xyz/utils@0.3.0, @poap-xyz/utils@workspace:packages/utils":
+"@poap-xyz/utils@*, @poap-xyz/utils@0.4.0, @poap-xyz/utils@workspace:packages/utils":
   version: 0.0.0-use.local
   resolution: "@poap-xyz/utils@workspace:packages/utils"
   languageName: unknown