@apolitical/sdk 8.0.2 → 8.1.0-ld.0

package/lib/index.d.ts

@@ -0,0 +1,349 @@
+interface LoadSdkOptions {
+  contentContext: { apiKey: string; previewKey: string; location: string };
+  errorsContext: { apiKey: string; serviceName: string };
+  gtmContext: { configs: { [key: string]: any } };
+  origin: string;
+}
+
+interface PeopleAPIUser {
+  [key: string]: any;
+}
+
+interface PeopleAPIUserCourse {
+  [key: string]: any;
+}
+
+interface PeopleAPIUserEvents {
+  [key: string]: any;
+}
+
+interface PeopleAPIUserLikes {
+  [key: string]: any;
+}
+
+interface PeopleAPIUserLesson {
+  [key: string]: any;
+}
+
+interface PeopleAPIUserProduct {
+  [key: string]: any;
+}
+
+interface PeopleAPIUserRating {
+  [key: string]: any;
+}
+
+interface PeopleAPIUserReferral {
+  [key: string]: any;
+}
+
+interface SocialsAPIActivity {
+  [key: string]: any;
+}
+
+interface SocialsAPICommunity {
+  [key: string]: any;
+}
+
+interface SocialsAPIReaction {
+  [key: string]: any;
+}
+
+interface SocialsAPILike {
+  slug: string;
+  activityId: string;
+  reactionId: string;
+}
+
+interface PostResponse {
+  created: true;
+}
+
+interface DeleteResponse {
+  removed?: true;
+  deleted?: true;
+}
+
+interface QueryParams {
+  [key: string]: string | number | boolean;
+}
+
+declare module '@apolitical/sdk' {
+  /**
+   * Loads the SDK using the provided options
+   *
+   * @param contentContext for setting up Contentful
+   * @param errorsContext for setting up GCP error logging
+   * @param gtmContext for setting up Google Tag Manager
+   * @param origin the origin of the page
+   */
+  export default function loadSdk(options: LoadSdkOptions): string;
+
+  /**
+   * Decodes a base64 string to plain string
+   * @param {String} value - The base64 string
+   * @return {String} value - The plain string
+   */
+  export function decodeBase64(value: string): string;
+
+  /**
+   * Logs the error message and reports the error to GCP
+   * @param {Error} error - The error object
+   */
+  export function reportError(error: Error): void;
+
+  //
+  // People API resources
+  // ----------------------------------------------------------------------
+  export const people: {
+    bulkEnrolments: {
+      /**
+       * Lists bulk enrolments from the People API
+       * @param {Object} params - Params to be passed to the request
+       * @return {Array} data - JSON array returned by the API
+       */
+      list: (params: QueryParams) => Promise<any[]>;
+    };
+    // TODO: add types for the rest of the handlers
+    handlers: {};
+    registrations: {
+      /**
+       * Lists registrations from the People API
+       * @param {Object} params - Params to be passed to the request
+       * @return {Object} data - JSON object returned by the API
+       */
+      list: (params: QueryParams) => Promise<any>;
+    };
+    users: {
+      /**
+       * Fetches a user by id
+       * @param {String} id - The id of the user
+       * @return {Promise} user - The user object
+       */
+      read: (id: string) => Promise<PeopleAPIUser>;
+      /**
+       * Lists users from the People API based on an array of ids
+       * @param {String} ids - The ids of the users (needs at least two)
+       * @return {Array} data - array with JSON objects returned by the API
+       */
+      list: (ids: string[]) => Promise<PeopleAPIUser[]>;
+      /**
+       * Updates a user in the People API
+       * @param {String} id - The id of the user
+       * @param {Object} payload - The data to update the user with
+       * @return {Promise} updated - Whether the user was updated or not
+       */
+      update: (id: string, payload: Partial<PeopleAPIUser>) => Promise<boolean>;
+    };
+    userCourses: {
+      /**
+       * Creates a user course in People API
+       * @param {Object} payload - The data to create the user course with
+       */
+      create: (payload: PeopleAPIUserCourse) => Promise<void>;
+      /**
+       * Lists user's courses from the People API based on the supplied params
+       * @param {String} params - The params to use to filter the courses
+       * @return {Array} data - array with JSON objects returned by the API
+       */
+      list: (params: QueryParams) => Promise<PeopleAPIUserCourse[]>;
+      /**
+       * Updates a user course in the People API
+       * @param {String} courseId - The id of the user course
+       * @param {Object} payload - The data to update the user course with
+       */
+      update: (courseId: string, payload: Partial<PeopleAPIUserCourse>) => Promise<void>;
+    };
+    userEvents: {
+      /**
+       * Lists user's events from the People API based on the supplied params
+       * * @param {String} params - The params to use to filter the events
+       * @return {Array} data - array with JSON objects returned by the API
+       */
+      list: (params: QueryParams) => Promise<PeopleAPIUserEvents[]>;
+    };
+    userLikes: {
+      /**
+       * Lists user's likes from the People API based on the supplied params
+       * @param {String} params - The params to use to filter the likes
+       * @return {Array} data - array with JSON objects returned by the API
+       */
+      list: (params: QueryParams) => Promise<PeopleAPIUserLikes[]>;
+    };
+    userLessons: {
+      /**
+       * Creates a user lesson in People API
+       * @param {Object} payload - The data to create the user lesson with
+       */
+      create: (payload: PeopleAPIUserLesson) => Promise<PeopleAPIUserLesson>;
+      /**
+       * Lists user's lessons from the People API based on the supplied params
+       * @param {String} params - The params to use to filter the lessons
+       * @return {Array} data - array with JSON objects returned by the API
+       */
+      list: (params: QueryParams) => Promise<PeopleAPIUserLesson[]>;
+    };
+    userProducts: {
+      /**
+       * Creates a user product in People API
+       * @param {Object} payload - The data to create the user product with
+       */
+      create: (payload: PeopleAPIUserProduct) => Promise<PeopleAPIUserProduct>;
+      /**
+       * Lists user's products from the People API based on the supplied params
+       * @param {String} params - The params to use to filter the products
+       * @return {Array} data - array with JSON objects returned by the API
+       */
+      list: (params: QueryParams) => Promise<PeopleAPIUserProduct[]>;
+      /**
+       * Updates a user product in the People API
+       * @param {String} productId - The id of the user product
+       * @param {Object} payload - The data to update the user product with
+       */
+      update: (productId: string, payload: Partial<PeopleAPIUserProduct>) => Promise<void>;
+    };
+    userRatings: {
+      /**
+       * Creates a user rating in People API
+       * @param {Object} payload - The data to create the user rating with
+       */
+      create: (payload: PeopleAPIUserRating) => Promise<PeopleAPIUserRating>;
+      /**
+       * Updates a user rating in the People API
+       * @param {String} ratingId - The id of the user rating
+       * @param {Object} payload - The data to update the user rating with
+       */
+      update: (ratingId: string, payload: Partial<PeopleAPIUserRating>) => Promise<void>;
+    };
+    userReferrals: {
+      /**
+       * Lists user's referrals from the People API based on the supplied params
+       * @param {String} params - The params to use to filter the referrals
+       * @return {Array} data - array with JSON objects returned by the API
+       */
+      list: (params: QueryParams) => Promise<PeopleAPIUserReferral[]>;
+    };
+  };
+
+  //
+  // Social API resources
+  // ----------------------------------------------------------------------
+  export const socials: {
+    activities: {
+      /**
+       * Creates an activity in Socials API
+       * @param {String} slug - The slug of the community
+       * @param {Object} payload - The data to create the activity with
+       * @return {Promise} activity - The activity object
+       */
+      create: (slug: string, payload: SocialsAPIActivity) => Promise<SocialsAPIActivity>;
+      /**
+       * Fetches an activity by slug in Socials API
+       * @param {String} slug - The slug of the community
+       * @param {String} activityId - The ID of the activity
+       * @return {Promise} activity - The activity object
+       */
+      read: (slug: string, activityId: string) => Promise<SocialsAPIActivity>;
+      /**
+       * Lists activities from the Socials API based on params
+       * @param {String} slug - The slug of the community
+       * @param {Object} params - Params to be passed to the request
+       * @return {Array} data - array with JSON objects returned by the API
+       */
+      list: (slug: string, params: QueryParams) => Promise<SocialsAPIActivity[]>;
+      /**
+       * Updates an activity in the Socials API
+       * @param {String} slug - The slug of the community
+       * @param {String} activityId - The ID of the activity
+       * @param {Object} payload - The data to update the activity with
+       * @return {Promise} activity - The activity object
+       */
+      update: (slug: string, activityId: string, payload: Partial<SocialsAPIActivity>) => Promise<SocialsAPIActivity>;
+      /**
+       * Removes an activity in the Socials API
+       * @param {String} slug - The slug of the community
+       * @param {String} activityId - The ID of the activity
+       * @return {Promise} activity - The activity object
+       */
+      remove: (slug: string, activityId: string) => Promise<DeleteResponse>;
+    };
+    communities: {
+      /**
+       * Fetches a community by slug in Socials API
+       * @param {String} slug - The slug of the community
+       * @return {Promise} community - The community object
+       */
+      read: (slug: string) => Promise<SocialsAPICommunity>;
+      /**
+       * Allows a user to join a community in Socials API
+       * @param {String} slug - The slug of the community
+       * @param {Object} payload - The data to join the community with
+       * @return {Promise} data - The join object
+       */
+      join: (slug: string, payload: SocialsAPICommunity) => Promise<PostResponse>;
+      /**
+       * Allows a user to leave a community in the Socials API
+       * @param {String} slug - The slug of the community
+       * @return {Promise} data - The deletion object
+       */
+      remove: (slug: string) => Promise<DeleteResponse>;
+    };
+    likes: {
+      /**
+       * Creates a like on a reaction in Socials API
+       * @param {String} slug - The slug of the community
+       * @param {String} activityId - The ID of the activity
+       * @param {String} reactionId - The ID of the reaction
+       * @return {Promise} reaction - The reaction object
+       */
+      create: (payload: SocialsAPILike) => Promise<SocialsAPIReaction>;
+      /**
+       * Allows a user to remove like on a reaction in the Socials API
+       * @param {String} slug - The slug of the community
+       * @param {String} reactionId - The ID of the reaction
+       * @return {Promise} data - The deletion object
+       */
+      remove: (payload: Exclude<SocialsAPILike, 'activityId'>) => Promise<DeleteResponse>;
+    };
+    reactions: {
+      /**
+       * Creates a reaction on a reaction in Socials API
+       * @param {String} slug - The slug of the community
+       * @param {String} activityId - The ID of the activity
+       * @param {String} reactionId - The ID of the reaction
+       * @return {Promise} reaction - The reaction object
+       */
+      create: (slug: string, activityId: string, reactionId: string) => Promise<SocialsAPIReaction>;
+      /**
+       * Removes a reaction on a reaction in the Socials API
+       * @param {String} slug - The slug of the community
+       * @param {String} reactionId - The ID of the reaction
+       * @return {Promise} data - The deletion object
+       */
+      remove: (slug: string, reactionId: string) => Promise<DeleteResponse>;
+
+      /**
+       * Updates a reaction on a reaction in the Socials API
+       * @param {String} slug - The slug of the community
+       * @param {String} activityId - The ID of the activity
+       * @param {String} reactionId - The ID of the reaction
+       * @param {Object} payload - The data to update the reaction with
+       */
+      update: (
+        slug: string,
+        activityId: string,
+        reactionId: string,
+        payload: Partial<SocialsAPIReaction>,
+      ) => Promise<SocialsAPIReaction>;
+
+      /**
+       * Lists reactions from the Socials API based on params
+       * @param {String} slug - The slug of the community
+       * @param {Object} payload - The data to create the reaction with
+       * @param {Object} params - Params to be passed to the request
+       * @return {Array}
+       */
+      list: (slug: string, payload: Exclude<SocialsAPILike, 'slug'>, params: any) => Promise<SocialsAPIReaction[]>;
+    };
+  };
+}

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "@apolitical/sdk",
-  "version": "8.0.2",
+  "version": "8.1.0-ld.0",
   "description": "Browser library to interact with Apolitical's APIs",
   "author": "Apolitical Group Limited <engineering@apolitical.co>",
   "license": "MIT",
   "main": "build/index.js",
   "files": [
-    "build/**"
+    "build/**",
+    "lib/index.d.ts"
   ],
+  "types": "lib/index.d.ts",
   "scripts": {
     "test": "jest --runInBand",
     "unit-test": "jest test/unit/* --bail --runInBand --passWithNoTests",