Skip to content

Commit 7c12674

Browse files
nacho9900nacho9900
authored
Refactor Moment Create Medias (poap-xyz#61)
* move ts-node as dev-dependency * Add medias as optional create moment input
1 parent 23b3d18 commit 7c12674

File tree

14 files changed

+113
-57
lines changed

14 files changed

+113
-57
lines changed

‎.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,7 @@ docs/.yarn/
1111
!.yarn/versions
1212
.next
1313
.idea
14-
.vscode
14+
.vscode
15+
16+
# Ignore Typescript definitions file extension
17+
*.d.ts

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

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
/* eslint-disable max-statements */
21
import { MomentsClient, CreateMomentInput } from '@poap-xyz/moments';
32
import fs from 'fs';
43
import mime from 'mime';
@@ -18,9 +17,14 @@ export const create_moment = async (client: MomentsClient): Promise<void> => {
1817
* The Token ID related to the moment (Optional)
1918
*/
2019
tokenId: 6568008,
21-
fileBinary: fileBuffer,
2220
author: '0x82AB2941Cf555CED5ad7Ed232a5B5f6083815FBC',
23-
fileType: mimeType,
21+
medias: [
22+
{
23+
fileBinary: fileBuffer,
24+
fileType: mimeType,
25+
},
26+
],
27+
description: 'This is a description',
2428
};
2529

2630
try {

‎package.json

+2-4
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,13 @@
4444
"rollup-plugin-peer-deps-external": "^2.2.4",
4545
"rollup-plugin-typescript2": "^0.31.1",
4646
"ts-jest": "^29.1.0",
47+
"ts-node": "^10.9.1",
4748
"typedoc": "^0.23.28",
4849
"typescript": "^5.0.2"
4950
},
5051
"workspaces": [
5152
"packages/*",
5253
"examples/**"
5354
],
54-
"packageManager": "[email protected]",
55-
"dependencies": {
56-
"ts-node": "^10.9.1"
57-
}
55+
"packageManager": "[email protected]"
5856
}

‎packages/drops/package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@poap-xyz/drops",
3-
"version": "0.0.35",
3+
"version": "0.0.36",
44
"description": "Drops module for the poap.js library",
55
"main": "dist/cjs/index.cjs",
66
"module": "dist/esm/index.mjs",
@@ -26,7 +26,7 @@
2626
"build": "rollup -c --bundleConfigAsCjs"
2727
},
2828
"dependencies": {
29-
"@poap-xyz/providers": "0.0.35",
30-
"@poap-xyz/utils": "0.0.35"
29+
"@poap-xyz/providers": "0.0.36",
30+
"@poap-xyz/utils": "0.0.36"
3131
}
3232
}

‎packages/moments/package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@poap-xyz/moments",
3-
"version": "0.0.35",
3+
"version": "0.0.36",
44
"description": "Moments module for the poap.js library",
55
"main": "dist/cjs/index.cjs",
66
"module": "dist/esm/index.mjs",
@@ -26,7 +26,7 @@
2626
"build": "rollup -c --bundleConfigAsCjs"
2727
},
2828
"dependencies": {
29-
"@poap-xyz/providers": "0.0.35",
30-
"@poap-xyz/utils": "0.0.35"
29+
"@poap-xyz/providers": "0.0.36",
30+
"@poap-xyz/utils": "0.0.36"
3131
}
3232
}

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

+19-2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ describe('MomentsClient', () => {
1313
const FILE_TYPE = 'image/png';
1414
const MEDIA_KEY = 'this-is-a-media-key';
1515
const MEDIA_UPLOAD_URL = 'this-is-a-media-upload-url';
16+
const DESCRIPTION = 'This is a description';
1617

1718
let poapMomentsAPIMocked: MockProxy<PoapMomentsApi>;
1819
let compassProviderMocked: MockProxy<PoapCompass>;
@@ -34,10 +35,15 @@ describe('MomentsClient', () => {
3435
const inputs: CreateMomentInput = {
3536
dropId: DROP_ID,
3637
tokenId: TOKEN_ID,
37-
fileBinary: FILE,
38-
fileType: FILE_TYPE,
38+
medias: [
39+
{
40+
fileBinary: FILE,
41+
fileType: FILE_TYPE,
42+
},
43+
],
3944
author: AUTHOR,
4045
onStepUpdate,
46+
description: DESCRIPTION,
4147
};
4248
poapMomentsAPIMocked.createMoment.mockResolvedValue({
4349
id: MOMENT_ID,
@@ -51,6 +57,14 @@ describe('MomentsClient', () => {
5157
url: MEDIA_UPLOAD_URL,
5258
});
5359

60+
const EXPECTED_MOMENT_CREATE_INPUT = {
61+
dropId: DROP_ID,
62+
tokenId: TOKEN_ID,
63+
author: AUTHOR,
64+
description: DESCRIPTION,
65+
mediaKeys: [MEDIA_KEY],
66+
};
67+
5468
// WHEN
5569
const moment = await client.createMoment(inputs);
5670

@@ -59,6 +73,9 @@ describe('MomentsClient', () => {
5973
expect(moment.author).toBe(AUTHOR);
6074
expect(moment.dropId).toBe(DROP_ID);
6175
expect(moment.tokenId).toBe(TOKEN_ID);
76+
expect(poapMomentsAPIMocked.createMoment).toHaveBeenCalledWith(
77+
EXPECTED_MOMENT_CREATE_INPUT,
78+
);
6279
expect(onStepUpdate).toHaveBeenCalledWith(
6380
CreateSteps.REQUESTING_MEDIA_UPLOAD_URL,
6481
);

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

+53-22
Original file line numberDiff line numberDiff line change
@@ -17,43 +17,46 @@ import {
1717
import { CreateMomentInput } from './dtos/create/CreateInput';
1818
import { CreateSteps } from './dtos/create/CreateSteps';
1919
import { FetchMomentsInput } from './dtos/fetch/FetchMomentsInput';
20+
import { CreateMedia } from './dtos/create/CreateMedia';
2021

2122
export class MomentsClient {
23+
private static readonly DEFAULT_ON_STEP_UPDATE = (): void => {
24+
//do nothing
25+
};
26+
2227
constructor(
2328
private poapMomentsApi: PoapMomentsApi,
2429
private CompassProvider: CompassProvider,
2530
) {}
2631

2732
public async createMoment(input: CreateMomentInput): Promise<Moment> {
28-
const defaultOnStepUpdate = (): void => {
29-
//do nothing
30-
};
31-
const onStepUpdate = input.onStepUpdate || defaultOnStepUpdate;
32-
void onStepUpdate(CreateSteps.REQUESTING_MEDIA_UPLOAD_URL);
33-
const { url, key } = await this.poapMomentsApi.getSignedUrl();
34-
void onStepUpdate(CreateSteps.UPLOADING_MEDIA);
35-
await this.poapMomentsApi.uploadFile(
36-
input.fileBinary,
37-
url,
38-
input.fileType,
39-
input.onFileUploadProgress,
40-
);
41-
void onStepUpdate(CreateSteps.UPLOADING_MEDIA_METADATA);
42-
// we will be adding metadata to the media in the future
43-
void onStepUpdate(CreateSteps.PROCESSING_MEDIA);
44-
try {
45-
await this.poapMomentsApi.waitForMediaProcessing(key, input.timeOut);
46-
} catch (error) {
47-
void onStepUpdate(CreateSteps.PROCESSING_MEDIA_ERROR);
48-
throw error;
33+
if (input.medias && input.medias.length > 1) {
34+
// TODO: implement multiple medias
35+
throw new Error('Multiple medias not supported yet');
36+
}
37+
38+
const onStepUpdate =
39+
input.onStepUpdate || MomentsClient.DEFAULT_ON_STEP_UPDATE;
40+
41+
const mediaKeys: string[] = [];
42+
if (input.medias && input.medias.length > 0) {
43+
const media = input.medias[0];
44+
const key = await this.createMedia(
45+
media,
46+
onStepUpdate,
47+
input.onFileUploadProgress,
48+
input.timeOut,
49+
);
50+
mediaKeys.push(key);
4951
}
52+
5053
void onStepUpdate(CreateSteps.UPLOADING_MOMENT);
5154
const response = await this.poapMomentsApi.createMoment({
5255
dropId: input.dropId,
5356
author: input.author,
54-
mediaKeys: [key],
5557
tokenId: input.tokenId,
5658
description: input.description,
59+
mediaKeys,
5760
});
5861
void onStepUpdate(CreateSteps.FINISHED);
5962
return new Moment(
@@ -66,6 +69,34 @@ export class MomentsClient {
6669
);
6770
}
6871

72+
private async createMedia(
73+
media: CreateMedia,
74+
onStepUpdate: (step: CreateSteps) => void | Promise<void>,
75+
onFileUploadProgress?: (progress: number) => void | Promise<void>,
76+
timeOut?: number,
77+
): Promise<string> {
78+
void onStepUpdate(CreateSteps.REQUESTING_MEDIA_UPLOAD_URL);
79+
const { url, key } = await this.poapMomentsApi.getSignedUrl();
80+
void onStepUpdate(CreateSteps.UPLOADING_MEDIA);
81+
await this.poapMomentsApi.uploadFile(
82+
media.fileBinary,
83+
url,
84+
media.fileType,
85+
onFileUploadProgress,
86+
);
87+
void onStepUpdate(CreateSteps.UPLOADING_MEDIA_METADATA);
88+
// we will be adding metadata to the media in the future
89+
void onStepUpdate(CreateSteps.PROCESSING_MEDIA);
90+
try {
91+
await this.poapMomentsApi.waitForMediaProcessing(key, timeOut);
92+
} catch (error) {
93+
void onStepUpdate(CreateSteps.PROCESSING_MEDIA_ERROR);
94+
throw error;
95+
}
96+
97+
return key;
98+
}
99+
69100
async fetch({
70101
limit,
71102
offset,

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

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,25 @@
11
import { CreateSteps } from './CreateSteps';
2+
import { CreateMedia } from './CreateMedia';
23

34
/**
45
* Interface representing the input needed to create a moment.
56
* @interface
67
* @property {number} dropId - The ID of the drop related to the moment.
78
* @property {number} [tokenId] - The ID of the token related to the moment (optional).
8-
* @property {Uint8Array} fileBinary - The binary of the file to be uploaded.
99
* @property {string} author - The author of the moment. An Ethereum address.
1010
* @property {string} description - The description of the moment (optional).
1111
* @property {string} timeOut - The amount of time to wait until media is processed.
12-
* @property {string} fileType - The type of the file.
1312
* @property {(step: CreateSteps) => void | Promise<void>} [onStepUpdate] - Optional callback function to be called when the step changes.
1413
* @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.
14+
* @property {CreateMedia[]} medias - The media to be uploaded.
1515
*/
1616
export interface CreateMomentInput {
17-
fileBinary: Uint8Array;
18-
fileType: string;
1917
author: string;
2018
description?: string;
2119
dropId: number;
2220
tokenId?: number;
2321
timeOut?: number;
2422
onStepUpdate?: (step: CreateSteps) => void | Promise<void>;
2523
onFileUploadProgress?: (progress: number) => void | Promise<void>;
24+
medias?: CreateMedia[];
2625
}

‎packages/moments/src/client/dtos/create/CreateMedia.ts

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
export interface CreateMedia {
2+
fileBinary: Uint8Array;
3+
fileType: string;
4+
}

‎packages/performance/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@poap-xyz/performance",
3-
"version": "0.0.35",
3+
"version": "0.0.36",
44
"description": "Performance module for the poap.js library",
55
"type": "module",
66
"main": "dist/cjs/index.cjs",

‎packages/poaps/package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@poap-xyz/poaps",
3-
"version": "0.0.35",
3+
"version": "0.0.36",
44
"description": "Poaps module for the poap.js library",
55
"main": "dist/cjs/index.cjs",
66
"module": "dist/esm/index.mjs",
@@ -26,7 +26,7 @@
2626
"build": "rollup -c --bundleConfigAsCjs"
2727
},
2828
"dependencies": {
29-
"@poap-xyz/providers": "0.0.35",
30-
"@poap-xyz/utils": "0.0.35"
29+
"@poap-xyz/providers": "0.0.36",
30+
"@poap-xyz/utils": "0.0.36"
3131
}
3232
}

‎packages/providers/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@poap-xyz/providers",
3-
"version": "0.0.35",
3+
"version": "0.0.36",
44
"description": "Providers module for the poap.js library",
55
"main": "dist/cjs/index.cjs",
66
"module": "dist/esm/index.mjs",

‎packages/utils/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@poap-xyz/utils",
3-
"version": "0.0.35",
3+
"version": "0.0.36",
44
"description": "Utils module for the poap.js library",
55
"type": "module",
66
"main": "dist/cjs/index.cjs",
@@ -25,5 +25,5 @@
2525
"scripts": {
2626
"build": "rollup -c --bundleConfigAsCjs"
2727
},
28-
"stableVersion": "0.0.35"
28+
"stableVersion": "0.0.36"
2929
}

‎yarn.lock

+8-8
Original file line numberDiff line numberDiff line change
@@ -864,17 +864,17 @@ __metadata:
864864
version: 0.0.0-use.local
865865
resolution: "@poap-xyz/drops@workspace:packages/drops"
866866
dependencies:
867-
"@poap-xyz/providers": 0.0.35
868-
"@poap-xyz/utils": 0.0.35
867+
"@poap-xyz/providers": 0.0.36
868+
"@poap-xyz/utils": 0.0.36
869869
languageName: unknown
870870
linkType: soft
871871

872872
"@poap-xyz/moments@*, @poap-xyz/moments@workspace:packages/moments":
873873
version: 0.0.0-use.local
874874
resolution: "@poap-xyz/moments@workspace:packages/moments"
875875
dependencies:
876-
"@poap-xyz/providers": 0.0.35
877-
"@poap-xyz/utils": 0.0.35
876+
"@poap-xyz/providers": 0.0.36
877+
"@poap-xyz/utils": 0.0.36
878878
languageName: unknown
879879
linkType: soft
880880

@@ -888,12 +888,12 @@ __metadata:
888888
version: 0.0.0-use.local
889889
resolution: "@poap-xyz/poaps@workspace:packages/poaps"
890890
dependencies:
891-
"@poap-xyz/providers": 0.0.35
892-
"@poap-xyz/utils": 0.0.35
891+
"@poap-xyz/providers": 0.0.36
892+
"@poap-xyz/utils": 0.0.36
893893
languageName: unknown
894894
linkType: soft
895895

896-
"@poap-xyz/providers@*, @poap-xyz/[email protected].35, @poap-xyz/providers@workspace:packages/providers":
896+
"@poap-xyz/providers@*, @poap-xyz/[email protected].36, @poap-xyz/providers@workspace:packages/providers":
897897
version: 0.0.0-use.local
898898
resolution: "@poap-xyz/providers@workspace:packages/providers"
899899
dependencies:
@@ -904,7 +904,7 @@ __metadata:
904904
languageName: unknown
905905
linkType: soft
906906

907-
"@poap-xyz/utils@*, @poap-xyz/[email protected].35, @poap-xyz/utils@workspace:packages/utils":
907+
"@poap-xyz/utils@*, @poap-xyz/[email protected].36, @poap-xyz/utils@workspace:packages/utils":
908908
version: 0.0.0-use.local
909909
resolution: "@poap-xyz/utils@workspace:packages/utils"
910910
languageName: unknown

0 commit comments

Comments
 (0)