@amityco/ts-sdk 0.0.1-beta.2 → 0.0.1-beta.22

package/dist/user/events/onUserFlagCleared.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { onUserFlagCleared } from '@amityco/ts-sdk'
+ * const dispose = onUserFlagCleared(user => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when flags have been cleared for a {@link Amity.User}
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category User Events
+ */
+export declare const onUserFlagCleared: (callback: Amity.Listener<Amity.User>) => Amity.Unsubscriber;
+//# sourceMappingURL=onUserFlagCleared.d.ts.map

package/dist/user/events/onUserFlagCleared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onUserFlagCleared.d.ts","sourceRoot":"","sources":["../../../src/user/events/onUserFlagCleared.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iBAAiB,aAAc,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,uBACb,CAAC"}

package/dist/user/events/onUserFlagged.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { onUserFlagged } from '@amityco/ts-sdk'
+ * const dispose = onUserFlagged(user => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.User} has been flagged
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category User Events
+ */
+export declare const onUserFlagged: (callback: Amity.Listener<Amity.User>) => Amity.Unsubscriber;
+//# sourceMappingURL=onUserFlagged.d.ts.map

package/dist/user/events/onUserFlagged.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onUserFlagged.d.ts","sourceRoot":"","sources":["../../../src/user/events/onUserFlagged.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,aAAc,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,uBACb,CAAC"}

package/dist/user/events/onUserUnflagged.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { onUserUnflagged } from '@amityco/ts-sdk'
+ * const dispose = onUserUnflagged(user => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a flag has been removed from a {@link Amity.User}
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category User Events
+ */
+export declare const onUserUnflagged: (callback: Amity.Listener<Amity.User>) => Amity.Unsubscriber;
+//# sourceMappingURL=onUserUnflagged.d.ts.map

package/dist/user/events/onUserUnflagged.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onUserUnflagged.d.ts","sourceRoot":"","sources":["../../../src/user/events/onUserUnflagged.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,eAAe,aAAc,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,uBACb,CAAC"}

package/dist/user/events/onUserUpdated.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { onUserUpdated } from '@amityco/ts-sdk'
+ * const dispose = onUserUpdated(user => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.User} has been updated
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category User Events
+ */
+export declare const onUserUpdated: (callback: Amity.Listener<Amity.User>) => Amity.Unsubscriber;
+//# sourceMappingURL=onUserUpdated.d.ts.map

package/dist/user/events/onUserUpdated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onUserUpdated.d.ts","sourceRoot":"","sources":["../../../src/user/events/onUserUpdated.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,aAAc,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,uBACb,CAAC"}

package/dist/user/events/utils.d.ts

@@ -0,0 +1,2 @@
+export declare const createUserEventSubscriber: (event: keyof Amity.MqttUserMessageEvents, callback: Amity.Listener<Amity.User>) => Amity.Unsubscriber;
+//# sourceMappingURL=utils.d.ts.map

package/dist/user/events/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/user/events/utils.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,yBAAyB,UAC7B,MAAM,MAAM,qBAAqB,YAC9B,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,uBAarC,CAAC"}

package/dist/user/observers/index.d.ts

@@ -0,0 +1,2 @@
+export { observeUser } from './observeUser';
+//# sourceMappingURL=index.d.ts.map

package/dist/user/observers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/user/observers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC"}

package/dist/user/observers/observeUser.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ```js
+ * import { observeUser } from '@amityco/ts-sdk'
+ *
+ * let user = {}
+ * const dispose = observeUser(userId, updated => user = updated)
+ * ```
+ *
+ * @param userId the ID of the user to observe
+ * @param callback the function to call when new data are available
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the user
+ *
+ * Observe all mutation on a given {@link Amity.User}
+ * @category User Observer
+ */
+export declare const observeUser: <Events extends ["onFetch", "onUpdate", "onDelete", "onFlagged", "onUnflagged", "onFlagCleared"]>(userId: string, callback: Amity.ObjectListener<Amity.Snapshot<Amity.User>, Events>) => Amity.Unsubscriber;
+//# sourceMappingURL=observeUser.d.ts.map

package/dist/user/observers/observeUser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"observeUser.d.ts","sourceRoot":"","sources":["../../../src/user/observers/observeUser.ts"],"names":[],"mappings":"AAaA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,WAAW,4GAGd,MAAM,yEAEb,MAAM,YAkCR,CAAC"}

package/dist/utils/env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="node" />
+export declare const safeProcess: Partial<NodeJS.Process>;
+export declare function getEnv(): NodeJS.ProcessEnv | undefined;
+export declare const isProduction: boolean;
+//# sourceMappingURL=env.d.ts.map

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

@@ -0,0 +1 @@
+{"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/dist/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION: string;
+//# sourceMappingURL=version.d.ts.map

package/dist/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,OAAO,QAAwC,CAAC"}

package/package.json

@@ -1,27 +1,60 @@
 {
   "name": "@amityco/ts-sdk",
-  "version": "0.0.1-beta.2",
+  "version": "0.0.1-beta.22",
   "license": "CC-BY-ND-4.0",
-  "author": "developers@amity.co",
+  "author": "amity.co <developers@amity.co> (https://amity.co)",
   "description": "Amity Social Cloud Typescript SDK",
-  "keywords": ["amity", "amity.co", "social", "messaging", "chat", "video", "ts", "js"],
-
-  "type": "module",
-  "main": "./index.js",
-  "types": "./index.d.ts",
-
+  "keywords": [
+    "amity",
+    "amity.co",
+    "social",
+    "messaging",
+    "chat",
+    "video",
+    "ts",
+    "js"
+  ],
+  "main": "./dist/index.cjs.js",
+  "module": "./dist/index.esm.js",
+  "unpkg": "./dist/index.umd.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
   "engines": {
     "node": ">=12",
     "npm": ">=6"
   },
-
+  "scripts": {
+    "clean": "rimraf ./dist",
+    "prebuild": "yarn run clean",
+    "build": "rollup -c ./rollup.config.js",
+    "prewatch": "yarn run clean",
+    "watch": "rollup -w -c ./rollup.config.js"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^21.0.3",
+    "@rollup/plugin-node-resolve": "^13.0.4",
+    "@rollup/plugin-replace": "^4.0.0",
+    "@types/axios": "^0.14.0",
+    "@types/debug": "^4.1.5",
+    "@types/node": "^17.0.23",
+    "@types/socket.io-client": "^1.4.34",
+    "chalk": "^4.1.2",
+    "concurrently": "^6.1.0",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.56.3",
+    "rollup-plugin-terser": "^7.0.2",
+    "rollup-plugin-typescript2": "^0.31.2",
+    "tslib": "^2.1.0",
+    "typescript": "^4.6.3"
+  },
   "dependencies": {
     "@react-native-async-storage/async-storage": "^1.15.5",
     "agentkeepalive": "^4.1.3",
-    "axios": "^0.21.1",
+    "axios": "0.21.1",
     "debug": "^4.3.1",
     "js-base64": "^3.6.1",
     "mitt": "^3.0.0",
+    "mqtt": "^4.2.8",
     "react-native-uuid": "^2.0.1",
     "socket.io-client": "2.2.0"
   }

package/rollup.config.js

@@ -0,0 +1,84 @@
+import chalk from 'chalk';
+import commonjs from '@rollup/plugin-commonjs';
+import resolve from '@rollup/plugin-node-resolve';
+import typescript from 'rollup-plugin-typescript2';
+import replace from '@rollup/plugin-replace';
+import { terser } from 'rollup-plugin-terser';
+
+import pkg from './package.json';
+
+const config = {
+  input: 'src/index.ts',
+  plugins: [
+    resolve({
+      jsnext: true,
+      main: true,
+      builtins: false,
+      browser: true,
+    }),
+    commonjs(),
+    typescript({
+      useTsconfigDeclarationDir: true,
+    }),
+  ],
+  onwarn: warning => {
+    // we don't allow circular dependencies other than those that we can not fix such as node_modules
+    if (warning.code === 'CIRCULAR_DEPENDENCY' && !warning.importer.includes('node_modules')) {
+      console.log(chalk.red('error'), warning.message);
+      process.exit(1);
+    }
+  },
+};
+
+export default [
+  {
+    ...config,
+    output: [
+      {
+        format: 'es',
+        file: pkg.module,
+      },
+    ],
+    external: Object.keys(pkg.dependencies),
+    plugins: [
+      ...config.plugins,
+      replace({
+        'process.env.NODE_ENV': `'${process.env.NODE_ENV}'`,
+        'process.env.VERSION': `'v${pkg.version}-esm'`,
+      }),
+    ],
+  },
+  {
+    ...config,
+    output: [
+      {
+        format: 'cjs',
+        file: pkg.main,
+      },
+    ],
+    external: Object.keys(pkg.dependencies),
+    plugins: [
+      ...config.plugins,
+      replace({
+        'process.env.NODE_ENV': `'${process.env.NODE_ENV}'`,
+        'process.env.VERSION': `'v${pkg.version}-cjs'`,
+      }),
+    ],
+  },
+  {
+    ...config,
+    output: {
+      format: 'iife',
+      name: 'Amity',
+      file: pkg.unpkg,
+    },
+    plugins: [
+      ...config.plugins,
+      replace({
+        'process.env.NODE_ENV': `'${process.env.NODE_ENV}'`,
+        'process.env.VERSION': `'v${pkg.version}-umd'`,
+      }),
+      terser(),
+    ],
+  },
+];

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

@@ -0,0 +1,70 @@
+export {};
+
+declare global {
+  namespace Amity {
+    /**
+     * Union of acceptable types for a chunk of cache key.
+     * Recursive type which allow 3 primitives + array or object of them.
+     *
+     * @hidden
+     */
+    type Serializable =
+      | string
+      | number
+      | boolean
+      | undefined
+      | Serializable[]
+      | { [key: string]: Serializable };
+
+    /**
+     * Cache key description. Similarly to react-query,
+     * the key is an array of serializable values.
+     */
+    type CacheKey = Serializable[];
+
+    /**
+     * Cache options are separated from CacheEntry for further type
+     * manipulations and passing of options in functions.
+     *
+     * The cache options are:
+     *   - cachedAt(number): used to check is the cached content is still
+     *     considered fresh or not.
+     *
+     *   - offline(boolean): used to determine if the entry must be
+     *     saved in persistent storage on top of the regular caching.
+     */
+    type CacheOptions = {
+      cachedAt: number | undefined;
+      offline?: boolean;
+    };
+
+    /**
+     * Cache entry wrapper. It contains the cached content
+     * itself (data: T) and also several other properties
+     * through CacheOptions to allow fine tuned control.
+     */
+    type CacheEntry<T extends unknown = unknown> = {
+      key: CacheKey;
+      data: T;
+    } & CacheOptions;
+
+    /**
+     * Minimal CacheEntry alias, used mostly
+     */
+    type Cached<T extends unknown = unknown> = (T extends Amity.Paged<any, infer K>
+      ? T
+      : { data: T }) & {
+      cachedAt: CacheOptions['cachedAt'];
+    };
+
+    /**
+     * Main interface for the cache data structure. There's no direct
+     * methods there as we want to keep the object easily serializable
+     * (over JSON.stringify/parse) for simple backup/hydration.
+     */
+    type Cache = {
+      data: Record<string, CacheEntry>;
+      persistIf?: (key: CacheKey, data?: any) => boolean;
+    };
+  }
+}

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

@@ -0,0 +1,38 @@
+export {};
+
+declare global {
+  namespace Amity {
+    const enum ErrorLevel {
+      ERROR = 'error',
+      FATAL = 'fatal',
+    }
+
+    const enum ServerError {
+      BAD_REQUEST = 400000,
+      UNAUTHORIZED = 400100,
+      PERMISSION_DENIED = 400301,
+      ITEM_NOT_FOUND = 400400,
+      CONFLICT = 400900,
+      FORBIDDEN = 400300,
+      USER_IS_MUTED = 400302,
+      CHANNEL_IS_MUTED = 400303,
+      CHANNEL_BAN = 400304,
+      GLOBAL_BAN = 400312,
+      NUMBER_OF_MEMBERS_EXCEEDED = 400305,
+      MAX_REPETITION_EXCEEDED = 400307,
+      BAN_WORD_FOUND = 400308,
+      LINK_NOT_ALLOWED = 400309,
+      BUSINESS_ERROR = 500000,
+    }
+
+    const enum ClientError {
+      UNKNOWN_ERROR = 800000,
+      INVALID_PARAMETERS = 800110,
+      QUERY_IN_PROGRESS = 800170,
+      CONNECTION_ERROR = 800210,
+      DISCONNECTED = 800211,
+    }
+
+    type ErrorCode = ServerError | ClientError;
+  }
+}

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

@@ -0,0 +1,121 @@
+/* eslint-disable camelcase */
+import { IConnectPacket, IDisconnectPacket, IPublishPacket } from 'mqtt/dist/mqtt';
+
+export {};
+
+declare global {
+  namespace Amity {
+    type Listener<T = any> = (params: T) => void;
+
+    type ObjectListener<T, K extends string[]> =
+      | Listener<T>
+      | ({
+          onEvent?: (event: K[number], params: T) => void;
+        } & {
+          [P in K[number]]?: Listener<T>;
+        });
+
+    type Unsubscriber = () => void;
+
+    type Subscriber<T = any> = (fn: Amity.Listener<T>) => Unsubscriber;
+
+    type WsEvents = {
+      disconnected: Amity.ErrorResponse | undefined;
+      error: Amity.ErrorResponse | undefined;
+      connect_error: Amity.ErrorResponse | undefined;
+      reconnect_error: Amity.ErrorResponse | undefined;
+      reconnect_failed: Amity.ErrorResponse | undefined;
+
+      'v3.channel.didCreate': Amity.ChannelPayload;
+      'v3.channel.didUpdate': Amity.ChannelPayload;
+      'v3.channel.didDelete': Amity.ChannelPayload;
+      'v3.channel.didJoin': Amity.ChannelPayload;
+      'v3.channel.didLeave': Amity.ChannelPayload;
+      'v3.channel.didAddUsers': Amity.ChannelMembershipPayload;
+      'v3.channel.didRemoveUsers': Amity.ChannelMembershipPayload;
+      'v3.channel.didBan': Amity.ChannelPayload;
+      'v3.channel.didUnban': Amity.ChannelPayload;
+
+      'v3.message.didCreate': Amity.MessagePayload;
+      'v3.message.didUpdate': Amity.MessagePayload;
+      'v3.message.didDelete': Amity.MessagePayload;
+
+      'video-streaming.didRecord': Amity.StreamPayload;
+      'video-streaming.didStart': Amity.StreamPayload;
+      'video-streaming.didStop': Amity.StreamPayload;
+    };
+
+    type MqttEvents = {
+      connect: IConnectPacket;
+      message: [topic: string, payload: Buffer, packet: IPublishPacket];
+      disconnect: IDisconnectPacket;
+      error: Error;
+      close: Error;
+      end: undefined;
+      reconnect: undefined;
+    };
+
+    type MqttCommunityUserMessageEvents = {
+      'community.joined': Amity.CommunityMembershipPayload;
+      'community.left': Amity.CommunityMembershipPayload;
+      'community.userAdded': Amity.CommunityMembershipPayload;
+      'community.userRemoved': Amity.CommunityMembershipPayload;
+      'community.userBanned': Amity.CommunityMembershipPayload;
+      'community.userUnbanned': Amity.CommunityMembershipPayload;
+    };
+
+    type MqttCommunityMessageEvents = {
+      'community.created': Amity.CommunityPayload;
+      'community.updated': Amity.CommunityPayload;
+      'community.deleted': Amity.CommunityPayload;
+    } & MqttCommunityUserMessageEvents;
+
+    type MqttPostMessageEvents = {
+      'post.created': Amity.PostPayload;
+      'post.updated': Amity.PostPayload;
+      'post.deleted': Amity.PostPayload;
+      'post.approved': Amity.PostPayload;
+      'post.declined': Amity.PostPayload;
+      'post.flagged': Amity.PostPayload;
+      'post.unflagged': Amity.PostPayload;
+      'post.addReaction': Amity.PostPayload & { reactor: Amity.Reaction };
+      'post.removeReaction': Amity.PostPayload & { reactor: Amity.Reaction };
+    };
+
+    type MqttCommentMessageEvents = {
+      'comment.created': Amity.CommentPayload;
+      'comment.updated': Amity.CommentPayload;
+      'comment.deleted': Amity.CommentPayload;
+      'comment.flagged': Amity.CommentPayload;
+      'comment.unflagged': Amity.CommentPayload;
+      'comment.addReaction': Amity.CommentPayload & { reactor: Amity.Reaction };
+      'comment.removeReaction': Amity.CommentPayload & { reactor: Amity.Reaction };
+    };
+
+    type MqttUserMessageEvents = {
+      'user.updated': Amity.UserPayload;
+      'user.deleted': Amity.UserPayload; // received from network topic
+      'user.flagged': Amity.UserPayload;
+      'user.unflagged': Amity.UserPayload;
+      'user.flagCleared': Amity.UserPayload;
+    };
+
+    type MqttFollowMessageEvents = {
+      'follow.created': Amity.FollowStatus;
+      'follow.requested': Amity.FollowStatus;
+      'follow.accepted': Amity.FollowStatus;
+      'follow.unfollowed': Amity.FollowStatus;
+      'follow.requestCanceled': Amity.FollowStatus;
+      'follow.requestDeclined': Amity.FollowStatus;
+      'follow.followerDeleted': Amity.FollowStatus;
+    };
+
+    type MqttMessageEvents = MqttCommunityMessageEvents &
+      MqttPostMessageEvents &
+      MqttCommentMessageEvents &
+      MqttUserMessageEvents &
+      MqttFollowMessageEvents;
+
+    type Events = WsEvents & MqttEvents & MqttMessageEvents;
+  }
+}

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

@@ -0,0 +1,62 @@
+export {};
+
+declare global {
+  namespace Amity {
+    /**
+     * type map of "domain name -> ASC model"
+     * @hidden
+     */
+    type Model = {
+      user: Amity.User;
+      file: Amity.File;
+      role: Amity.Role;
+
+      channel: Amity.Channel;
+      channelUsers: Amity.Membership<'channel'>;
+      message: Amity.Message;
+
+      community: Amity.Community;
+      category: Amity.Category;
+      communityUsers: Amity.Membership<'community'>;
+      post: Amity.Post;
+      comment: Amity.Comment;
+      poll: Amity.Poll;
+      reaction: Amity.Reaction;
+
+      stream: Amity.Stream;
+
+      follow: Amity.FollowStatus;
+      followCount: Amity.FollowCount;
+    };
+
+    type Domain = keyof Model;
+
+    /**
+     * Definition of the minimal set of properties necessary to identify
+     * successfully a model.
+     * @hidden
+     */
+    type Minimal = {
+      user: Pick<Amity.User, 'userId'>;
+      file: Pick<Amity.File, 'fileId'>;
+      role: Pick<Amity.Role, 'roleId'>;
+
+      channel: Pick<Amity.Channel, 'channelId'>;
+      channelUsers: Pick<Amity.Membership<'channel'>, 'channelId' | 'userId'>;
+      message: Pick<Amity.Message, 'messageId'>;
+
+      community: Pick<Amity.Community, 'communityId'>;
+      category: Pick<Amity.Category, 'categoryId'>;
+      communityUsers: Pick<Amity.Membership<'community'>, 'communityId' | 'userId'>;
+      post: Pick<Amity.Post, 'postId'>;
+      comment: Pick<Amity.Comment, 'commentId'>;
+      poll: Pick<Amity.Poll, 'pollId'>;
+      reaction: Pick<Amity.Reaction, 'reactionId'>;
+
+      stream: Pick<Amity.Stream, 'streamId'>;
+
+      follow: Pick<Amity.FollowStatus, 'from' | 'to'>;
+      followCount: Pick<Amity.FollowCount, 'userId'>;
+    };
+  }
+}

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

@@ -0,0 +1,60 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type PaginationStyles = 'skiplimit' | 'afterbefore' | 'afterbeforeraw';
+
+    type PageLimit = {
+      limit: number;
+    };
+
+    type PrevPage<T extends number | string> = PageLimit & {
+      after?: never;
+      before?: T;
+    };
+
+    type NextPage<T extends number | string> = PageLimit & {
+      after?: T;
+      before?: never;
+    };
+
+    type Page = PrevPage<number> | NextPage<number>;
+
+    /*
+      updatedAt is here because if you need sort by updatedAt you
+      need to include this data in query also
+    */
+    type PageRaw = (PrevPage<string> | NextPage<string>) & {
+      updatedAt?: string;
+    };
+
+    type SkipLimitPagination = {
+      skip?: number;
+      limit?: number;
+    };
+
+    /*
+      WARNING:
+      in traditional "before/after" pagination, 'before' and 'after'
+      normally should be strings representing the unique id of the
+      resource. for some reason, our backend uses a number instead,
+      bound to "channelSegment" (for message) and "segmentNumber" (
+      for comments). so we have to cast this as number.
+    */
+    type AfterBeforePagination = {
+      before?: number;
+      after?: number;
+      first?: number;
+      last?: number;
+    };
+
+    type AfterBeforeRawPagination = PageRaw;
+
+    type Pages<T extends Page | PageRaw> = {
+      nextPage?: T;
+      prevPage?: T;
+    };
+
+    type Paged<T, K extends Page | PageRaw = Page> = { data: T[] } & Pages<K>;
+  }
+}