@amityco/ts-sdk 0.0.1-beta.17 → 0.0.1-beta.18

package/dist/poll/api/closePoll.d.ts

@@ -0,0 +1,16 @@
+/**
+ * ```js
+ * import { closePoll } from '@amityco/ts-sdk'
+ * const updated = await closePoll(pollId)
+ * ```
+ *
+ * Updates an {@link Amity.Poll}
+ *
+ * @param pollId The ID of the {@link Amity.Poll} to close
+ * @returns the updated {@link Amity.Poll} object
+ *
+ * @category Poll API
+ * @async
+ */
+export declare const closePoll: (pollId: Amity.Poll['pollId']) => Promise<Amity.Cached<Amity.Poll>>;
+//# sourceMappingURL=closePoll.d.ts.map

package/dist/poll/api/closePoll.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"closePoll.d.ts","sourceRoot":"","sources":["../../../src/poll/api/closePoll.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,SAAS,WACZ,MAAM,IAAI,CAAC,QAAQ,CAAC,KAC3B,QAAQ,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,CAkBlC,CAAC"}

package/dist/poll/api/createPoll.d.ts

@@ -0,0 +1,23 @@
+/**
+ * ```js
+ * import { createPoll } from '@amityco/ts-sdk'
+ * const created = await createPoll({
+ *   question: 'question',
+ *   answers: [
+ *      { dataType: 'text', data: 'answer1' },
+ *      { dataType: 'text', data: 'answer2' },
+ *   ],
+ *   closedIn: 1649136484
+ * }))
+ * ```
+ *
+ * Creates an {@link Amity.Poll}
+ *
+ * @param bundle The data necessary to create a new {@link Amity.Poll}
+ * @returns The newly created {@link Amity.Poll}
+ *
+ * @category Poll API
+ * @async
+ */
+export declare const createPoll: (bundle: Pick<Amity.Poll, 'question' | 'answers' | 'answerType' | 'closedIn'>) => Promise<Amity.Cached<Amity.Poll>>;
+//# sourceMappingURL=createPoll.d.ts.map

package/dist/poll/api/createPoll.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createPoll.d.ts","sourceRoot":"","sources":["../../../src/poll/api/createPoll.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,UAAU,WACb,KAAK,MAAM,IAAI,EAAE,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,UAAU,CAAC,KAC3E,QAAQ,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,CAelC,CAAC"}

package/dist/poll/api/deletePoll.d.ts

@@ -0,0 +1,16 @@
+/**
+ * ```js
+ * import { deletePoll } from '@amityco/ts-sdk'
+ * const success = await deletePoll(pollId)
+ * ```
+ *
+ * Deletes a {@link Amity.Poll}
+ *
+ * @param pollId The {@link Amity.Poll} ID to delete
+ * @return A success boolean if the {@link Amity.Poll} was deleted
+ *
+ * @category Poll API
+ * @async
+ */
+export declare const deletePoll: (pollId: Amity.Poll['pollId']) => Promise<boolean>;
+//# sourceMappingURL=deletePoll.d.ts.map

package/dist/poll/api/deletePoll.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deletePoll.d.ts","sourceRoot":"","sources":["../../../src/poll/api/deletePoll.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU,WAAkB,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAG,QAAQ,OAAO,CAe9E,CAAC"}

package/dist/poll/api/getPoll.d.ts

@@ -0,0 +1,32 @@
+/**
+ * ```js
+ * import { getPoll } from '@amityco/ts-sdk'
+ * const poll = await getPoll('foobar')
+ * ```
+ *
+ * Fetches a {@link Amity.Poll} object
+ *
+ * @param pollId the ID of the {@link Amity.Poll} to fetch
+ * @returns the associated {@link Amity.Poll} object
+ *
+ * @category Poll API
+ * @async
+ */
+export declare const getPoll: {
+    (pollId: Amity.Poll['pollId']): Promise<Amity.Cached<Amity.Poll>>;
+    /**
+     * ```js
+     * import { getPoll } from '@amityco/ts-sdk'
+     * const poll = getPoll.locally('foobar')
+     * ```
+     *
+     * Fetches a {@link Amity.Poll} object
+     *
+     * @param pollId the ID of the {@link Amity.Poll} to fetch
+     * @returns the associated {@link Amity.Poll} object
+     *
+     * @category Poll API
+     */
+    locally(pollId: Amity.Poll['pollId']): Amity.Cached<Amity.Poll> | undefined;
+};
+//# sourceMappingURL=getPoll.d.ts.map

package/dist/poll/api/getPoll.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPoll.d.ts","sourceRoot":"","sources":["../../../src/poll/api/getPoll.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,OAAO;aAAkB,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,QAAQ,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC;IAiB9F;;;;;;;;;;;;OAYG;oBACwB,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS;CAfrF,CAAC"}

package/dist/poll/api/index.d.ts

@@ -0,0 +1,6 @@
+export * from './getPoll';
+export * from './createPoll';
+export * from './closePoll';
+export * from './deletePoll';
+export * from './votePoll';
+//# sourceMappingURL=index.d.ts.map

package/dist/poll/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/poll/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAE1B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAE7B,cAAc,YAAY,CAAC"}

package/dist/poll/api/votePoll.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { votePoll } from '@amityco/ts-sdk'
+ * const voted = await votePoll(pollId)
+ * ```
+ *
+ * Votes for an {@link Amity.Poll}
+ *
+ * @param pollId The ID of the {@link Amity.Poll} to vote
+ * @param answerIds The IDs of the {@link Amity.Poll} answers to vote {@link Amity.Poll}
+ * @returns the updated {@link Amity.Poll} object
+ *
+ * @category Poll API
+ * @async
+ */
+export declare const votePoll: (pollId: Amity.Poll['pollId'], answerIds: string[]) => Promise<Amity.Cached<Amity.Poll>>;
+//# sourceMappingURL=votePoll.d.ts.map

package/dist/poll/api/votePoll.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"votePoll.d.ts","sourceRoot":"","sources":["../../../src/poll/api/votePoll.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,QAAQ,WACX,MAAM,IAAI,CAAC,QAAQ,CAAC,aACjB,MAAM,EAAE,KAClB,QAAQ,MAAM,MAAM,CAAC,MAAM,IAAI,CAAC,CAkBlC,CAAC"}

package/dist/utils/env.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"env.d.ts","sourceRoot":"","sources":["../../src/utils/env.ts"],"names":[],"mappings":";AAGA,eAAO,MAAiB,WAAW,yBAAyD,CAAC;AAE7F,wBAAgB,MAAM,IAAI,MAAM,CAAC,UAAU,GAAG,SAAS,CAEtD;AAED,eAAO,MAAM,YAAY,SAA6C,CAAC"}
+{"version":3,"file":"env.d.ts","sourceRoot":"","sources":["../../src/utils/env.ts"],"names":[],"mappings":";AAKA,eAAO,MAAiB,WAAW,yBAAyD,CAAC;AAE7F,wBAAgB,MAAM,IAAI,MAAM,CAAC,UAAU,GAAG,SAAS,CAEtD;AAED,eAAO,MAAM,YAAY,SAA6C,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amityco/ts-sdk",
-  "version": "0.0.1-beta.17",
+  "version": "0.0.1-beta.18",
   "license": "CC-BY-ND-4.0",
   "author": "amity.co <developers@amity.co> (https://amity.co)",
   "description": "Amity Social Cloud Typescript SDK",

package/src/@types/core/model.ts

@@ -20,6 +20,7 @@ declare global {
       communityUsers: Amity.Membership<'community'>;
       post: Amity.Post;
       comment: Amity.Comment;
+      poll: Amity.Poll;
 
       stream: Amity.Stream;
 
@@ -48,6 +49,7 @@ declare global {
       communityUsers: Pick<Amity.Membership<'community'>, 'communityId' | 'userId'>;
       post: Pick<Amity.Post, 'postId'>;
       comment: Pick<Amity.Comment, 'commentId'>;
+      poll: Pick<Amity.Poll, 'pollId'>;
 
       stream: Pick<Amity.Stream, 'streamId'>;
 

package/src/@types/core/payload.ts

@@ -14,6 +14,7 @@ declare global {
       communityUser: Amity.CommunityMembershipPayload;
       post: Amity.PostPayload;
       comment: Amity.CommentPayload;
+      poll: Amity.PollPayload;
       stream: Amity.StreamPayload;
     };
 
@@ -98,6 +99,11 @@ declare global {
       files?: Amity.File[];
     };
 
+    type PollPayload = {
+      users: Amity.User[];
+      polls: Amity.Poll[];
+    };
+
     type GlobalFeedPayload = Amity.PostPayload;
 
     type FollowersPayload = {

package/src/@types/domains/poll.ts

@@ -0,0 +1,32 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type PollDataType = 'text';
+
+    type PollAnswerType = 'single' | 'multiple';
+
+    type PollAnswer = {
+      id: string;
+      dataType: PollDataType;
+      data: string;
+      voteCount: number;
+      isVotedByUser: boolean;
+    };
+
+    type PollStatus = 'closed' | 'open';
+
+    type Poll = {
+      pollId: string;
+      question: string;
+      answers: PollAnswer[];
+      answerType: PollAnswerType;
+      closedAt?: Amity.timestamp;
+      closedIn?: number;
+      isVoted?: boolean;
+      status: PollStatus;
+      userId: Amity.User['userId'];
+    } & Amity.Timestamps &
+      Amity.SoftDelete;
+  }
+}

package/src/@types/domains/post.ts

@@ -5,7 +5,7 @@ declare global {
     // bad hack until we get proper feed objects in backend
     type PostTargetType = Amity.FeedType | 'content';
 
-    type PostContentType = 'text' | 'image' | 'file' | 'video';
+    type PostContentType = 'text' | 'image' | 'file' | 'video' | 'liveStream' | 'poll';
 
     type Post<T extends PostContentType = any> = {
       postId: string;

package/src/@types/index.ts

@@ -32,3 +32,5 @@ import './domains/comment';
 import './domains/stream';
 
 import './domains/mention';
+
+import './domains/poll';

package/src/channel/api/deleteChannel.ts

@@ -22,7 +22,6 @@ export const deleteChannel = async (
   const client = getActiveClient();
   client.log('channel/deleteChannel', channelId);
 
-  // API-FIX: This endpoint has not been implemented yet.
   await client.http.delete<{ success: boolean }>(
     `/api/v3/channels/${encodeURIComponent(channelId)}`,
   );

package/src/core/model/idResolvers.ts

@@ -23,6 +23,7 @@ const idResolvers: Resolvers = {
   communityUsers: ({ communityId, userId }) => `${communityId}#${userId}`,
   post: ({ postId }) => postId,
   comment: ({ commentId }) => commentId,
+  poll: ({ pollId }) => pollId,
 
   stream: ({ streamId }) => streamId,
 

package/src/core/model/identifyModel.ts

@@ -31,6 +31,7 @@ const CRITERIAS: Criterias = {
   communityUsers: ['userId', 'communityId', 'communityMembership'],
   post: ['postId', 'feedId'],
   comment: ['commentId', 'referenceId'],
+  poll: ['pollId'],
   stream: ['streamId'],
   follow: ['from', 'to'],
   followCount: ['userId', 'followerCount'],

package/src/core/model/index.ts

@@ -20,6 +20,7 @@ export const PAYLOAD2MODEL: Record<string, Amity.Domain> = {
   posts: 'post',
   postChildren: 'post',
   comments: 'comment',
+  polls: 'poll',
   videoStreamings: 'stream',
 
   follows: 'follow',

package/src/core/subscription.ts

@@ -37,9 +37,7 @@ export const getUserTopic = (
   level: Exclude<SubscriptionLevels, SubscriptionLevels.COMMUNITY> = SubscriptionLevels.USER,
 ): string =>
   getCommunityUserTopic(
-    level === SubscriptionLevels.USER
-      ? path
-      : path.replace(/^(?<networkId>\w*)/, '$<networkId>/social'),
+    level === SubscriptionLevels.USER ? path : path.replace(/^(\w*)/, '$1/social'),
     level,
   );
 

package/src/file/api/createFile.ts

@@ -20,19 +20,19 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 export const createFile = async <T extends Amity.FileType = any>(
   formData: FormData,
   onProgress?: (percent: number) => void,
-): Promise<Amity.Cached<Amity.File>> => {
+): Promise<Amity.Cached<Amity.File[]>> => {
   const client = getActiveClient();
   client.log('file/createFile', formData);
 
-  if (!formData.getAll('file').length)
-    throw new Error('The formData object must have a `file` key.');
+  if (!formData.getAll('files').length)
+    throw new Error('The formData object must have a `files` key.');
 
   const headers =
     'getHeaders' in formData
       ? (formData as any).getHeaders()
       : { 'content-type': 'multipart/form-data' };
 
-  const { data } = await client.http.post<Amity.CreateFilePayload<T>>('/api/v3/files', formData, {
+  const { data } = await client.http.post<Amity.CreateFilePayload<T>>('/api/v4/files', formData, {
     headers,
     onUploadProgress({ loaded, total }) {
       onProgress && onProgress(Math.round((loaded * 100) / total));
@@ -46,7 +46,7 @@ export const createFile = async <T extends Amity.FileType = any>(
   if (client.cache) ingestInCache({ files: data }, { cachedAt });
 
   return {
-    data: data[0],
+    data,
     cachedAt,
   };
 };

package/src/index.ts

@@ -58,5 +58,7 @@ export * from './comment/api';
 export * from './comment/events';
 export * from './comment/observers';
 
+export * from './poll/api';
+
 export * from './stream/api';
 export * from './stream/events';

package/src/poll/api/closePoll.ts

@@ -0,0 +1,39 @@
+import { getActiveClient } from '~/client/api';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+/**
+ * ```js
+ * import { closePoll } from '@amityco/ts-sdk'
+ * const updated = await closePoll(pollId)
+ * ```
+ *
+ * Updates an {@link Amity.Poll}
+ *
+ * @param pollId The ID of the {@link Amity.Poll} to close
+ * @returns the updated {@link Amity.Poll} object
+ *
+ * @category Poll API
+ * @async
+ */
+export const closePoll = async (
+  pollId: Amity.Poll['pollId'],
+): Promise<Amity.Cached<Amity.Poll>> => {
+  const client = getActiveClient();
+  client.log('user/closePoll', pollId);
+
+  const { data } = await client.http.put<Amity.PollPayload>(
+    `/api/v3/polls/${encodeURIComponent(pollId)}`,
+    { status: 'closed' },
+  );
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  const { polls } = data;
+
+  return {
+    data: polls.find(poll => poll.pollId === pollId)!,
+    cachedAt,
+  };
+};

package/src/poll/api/createPoll.ts

@@ -0,0 +1,43 @@
+import { getActiveClient } from '~/client/api';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+/**
+ * ```js
+ * import { createPoll } from '@amityco/ts-sdk'
+ * const created = await createPoll({
+ *   question: 'question',
+ *   answers: [
+ *      { dataType: 'text', data: 'answer1' },
+ *      { dataType: 'text', data: 'answer2' },
+ *   ],
+ *   closedIn: 1649136484
+ * }))
+ * ```
+ *
+ * Creates an {@link Amity.Poll}
+ *
+ * @param bundle The data necessary to create a new {@link Amity.Poll}
+ * @returns The newly created {@link Amity.Poll}
+ *
+ * @category Poll API
+ * @async
+ */
+export const createPoll = async (
+  bundle: Pick<Amity.Poll, 'question' | 'answers' | 'answerType' | 'closedIn'>,
+): Promise<Amity.Cached<Amity.Poll>> => {
+  const client = getActiveClient();
+  client.log('post/createPoll', bundle);
+
+  const { data } = await client.http.post<Amity.PollPayload>('/api/v3/polls', bundle);
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  const { polls } = data;
+
+  return {
+    data: polls[0],
+    cachedAt,
+  };
+};

package/src/poll/api/deletePoll.ts

@@ -0,0 +1,36 @@
+import { getActiveClient } from '~/client/api';
+
+import { upsertInCache } from '~/cache/api';
+
+import { getPoll } from './getPoll';
+
+/**
+ * ```js
+ * import { deletePoll } from '@amityco/ts-sdk'
+ * const success = await deletePoll(pollId)
+ * ```
+ *
+ * Deletes a {@link Amity.Poll}
+ *
+ * @param pollId The {@link Amity.Poll} ID to delete
+ * @return A success boolean if the {@link Amity.Poll} was deleted
+ *
+ * @category Poll API
+ * @async
+ */
+export const deletePoll = async (pollId: Amity.Poll['pollId']): Promise<boolean> => {
+  const client = getActiveClient();
+  client.log('poll/deletePoll', pollId);
+
+  const poll = await getPoll(pollId);
+
+  // API-FIX: it returns { success: boolean } but seems it should be Amity.Response<{ success: boolean }
+  const { data } = await client.http.delete<{ success: boolean }>(`/api/v3/polls/${pollId}`);
+
+  const { success } = data; // unwrapPayload(data)
+  const deleted = { ...poll.data, isDeleted: true };
+
+  upsertInCache(['poll', 'get', pollId], deleted);
+
+  return success;
+};

package/src/poll/api/getPoll.ts

@@ -0,0 +1,64 @@
+import { getActiveClient } from '~/client/api';
+
+import { pullFromCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+/**
+ * ```js
+ * import { getPoll } from '@amityco/ts-sdk'
+ * const poll = await getPoll('foobar')
+ * ```
+ *
+ * Fetches a {@link Amity.Poll} object
+ *
+ * @param pollId the ID of the {@link Amity.Poll} to fetch
+ * @returns the associated {@link Amity.Poll} object
+ *
+ * @category Poll API
+ * @async
+ */
+export const getPoll = async (pollId: Amity.Poll['pollId']): Promise<Amity.Cached<Amity.Poll>> => {
+  const client = getActiveClient();
+  client.log('poll/getPoll', pollId);
+
+  const { data } = await client.http.get<Amity.PollPayload>(`/api/v3/polls/${pollId}`);
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  const { polls } = data;
+
+  return {
+    data: polls.find(poll => poll.pollId === pollId)!,
+    cachedAt,
+  };
+};
+
+/**
+ * ```js
+ * import { getPoll } from '@amityco/ts-sdk'
+ * const poll = getPoll.locally('foobar')
+ * ```
+ *
+ * Fetches a {@link Amity.Poll} object
+ *
+ * @param pollId the ID of the {@link Amity.Poll} to fetch
+ * @returns the associated {@link Amity.Poll} object
+ *
+ * @category Poll API
+ */
+getPoll.locally = (pollId: Amity.Poll['pollId']): Amity.Cached<Amity.Poll> | undefined => {
+  const client = getActiveClient();
+  client.log('poll/getPoll', pollId);
+
+  if (!client.cache) return;
+
+  const cached = pullFromCache<Amity.Poll>(['poll', 'get', pollId]);
+
+  if (!cached) return;
+
+  return {
+    data: cached.data,
+    cachedAt: cached.cachedAt,
+  };
+};

package/src/poll/api/index.ts

@@ -0,0 +1,7 @@
+export * from './getPoll';
+
+export * from './createPoll';
+export * from './closePoll';
+export * from './deletePoll';
+
+export * from './votePoll';

package/src/poll/api/votePoll.ts

@@ -0,0 +1,41 @@
+import { getActiveClient } from '~/client/api';
+
+import { ingestInCache } from '~/cache/api/ingestInCache';
+
+/**
+ * ```js
+ * import { votePoll } from '@amityco/ts-sdk'
+ * const voted = await votePoll(pollId)
+ * ```
+ *
+ * Votes for an {@link Amity.Poll}
+ *
+ * @param pollId The ID of the {@link Amity.Poll} to vote
+ * @param answerIds The IDs of the {@link Amity.Poll} answers to vote {@link Amity.Poll}
+ * @returns the updated {@link Amity.Poll} object
+ *
+ * @category Poll API
+ * @async
+ */
+export const votePoll = async (
+  pollId: Amity.Poll['pollId'],
+  answerIds: string[],
+): Promise<Amity.Cached<Amity.Poll>> => {
+  const client = getActiveClient();
+  client.log('user/votePoll', pollId);
+
+  const { data } = await client.http.post<Amity.PollPayload>(
+    `/api/v3/polls/${encodeURIComponent(pollId)}/votes`,
+    { pollId, answerIds },
+  );
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  const { polls } = data;
+
+  return {
+    data: polls.find(poll => poll.pollId === pollId)!,
+    cachedAt,
+  };
+};

package/src/utils/env.ts

@@ -1,5 +1,7 @@
 /* eslint-disable no-undef */
-const theGlobal = globalThis || global || window;
+const theGlobal =
+  // eslint-disable-next-line no-nested-ternary
+  typeof globalThis === 'object' ? globalThis : typeof global === 'object' ? global : window;
 
 export const { process: safeProcess = {} }: { process: Partial<NodeJS.Process> } = theGlobal;