🚧 Implement 2 to master (v0.2.0)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "snek-client",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Enoy it.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

src/config.json

@@ -0,0 +1,6 @@
+{
+  "anonUser": {
+    "username": "cisco",
+    "password": "ciscocisco"
+  }
+}

src/index.ts

@@ -78,7 +78,7 @@ class SnekClient extends Client {
    * @param type A type description to differ between multiple instances
    */
   constructor(
-    url: string = "https://engine.snek.at/api/graphiql",
+    url: string = "https://engine.snek.at/graphql",
     headers: object = {},
     type: string = "graphql"
   ) {

src/session/sessions.ts

@@ -24,6 +24,8 @@ import SnekTasks from "../templates/snek/gql/tasks/index";
 import { ApolloEndpoint } from "../endpoints/index";
 // Contains basic session interfaces
 import { User } from "./index";
+//> Config
+import Config from "../config.json";
 //#endregion
 
 //#region > Classes
@@ -206,31 +208,38 @@ class SnekSession extends CookieSession {
    * @returns {Promise<any>} A UserData object
    */
   async begin(user?: User): Promise<any> {
-    let response;
+    let anonymous = false;
 
     if (!user && this.refreshToken) {
       /* Refresh token and retrieve a new refreshToken if necessary */
       this.refresh();
     } else {
+      let authData;
+
       if (!user) {
         /* Authenticate anonymous user */
-        response = await this.tasks.auth.anon();
+        authData = (await this.tasks.auth.anon()).data?.auth;
+        anonymous = true;
       } else {
         /* Authenticate real user */
-        response = await this.tasks.auth.nonanon(user);
+        authData = (await this.tasks.auth.nonanon(user)).data?.auth;
       }
 
       /* Set tokens */
-      this.token = response.data?.auth.token;
-      this.refreshToken = response.data?.auth.refreshToken;
+      this.token = authData?.token;
+      this.refreshToken = authData?.refreshToken;
 
-      return response.data?.auth.user;
+      return { anonymous, ...authData?.user };
     }
 
     /* Get user data */
-    response = await this.tasks.user.whoami();
+    const userData = (await this.tasks.user.whoami()).data?.whoami;
+
+    if (userData?.username === Config.anonUser.username) {
+      anonymous = true;
+    }
 
-    return response.data?.whoami;
+    return { anonymous, ...userData };
   }
 
   /**

src/templates/snek/gql/mutations/jwtAuth.ts

@@ -21,11 +21,6 @@ const auth = gql`
       refreshToken
       user {
         username
-        firstName
-        lastName
-        email
-        dateJoined
-        lastLogin
       }
     }
   }

src/templates/snek/gql/mutations/user.ts

@@ -17,17 +17,16 @@ import gql from "graphql-tag";
  */
 const registration = gql`
   mutation registration($token: String!, $values: GenericScalar!) {
-    registration: registrationRegistrationFormPage(
-      token: $token
-      url: "/registration"
-      values: $values
-    ) {
-      result
-      errors {
-        name
-        errors
+    registration: registrationFormPage(
+      url: "/registration/",
+      token: $token,
+      values: $values) {
+        result
+        errors {
+          name
+          errors
+        }
       }
-    }
   }
 `;
 

src/templates/snek/gql/queries/general.ts

@@ -15,13 +15,13 @@ import gql from "graphql-tag";
  */
 const gitlabServer = gql`
   query gitLabServers($token: String!) {
-    page(url: "/registration", token: $token) {
-      ... on RegistrationRegistrationFormPage {
+    page(slug: "registration", token: $token) {
+      ... on RegistrationFormPage {
         supportedGitlabs {
-          ... on RegistrationGitlab_Server {
+          ... on Gitlab_Server {
+            id
             organisation
             domain
-            field
           }
         }
       }
@@ -43,10 +43,28 @@ const allPageUrls = gql`
     }
   }
 `;
+
+/**
+ * List of user page urls.
+ *
+ * @param {string} JWT A users JWT
+ * @returns {string} A serialized JSON object with a list of all page urls
+ * @description A query to fetch all user page urls
+ */
+const allUserPageUrls = gql`
+  query userPages($token: String!) {
+    page(slug: "user", token: $token) {
+      children {
+        slug
+        title
+      }
+    }
+  }
+`;
 //#endregion
 
 //#region > Exports
-export { gitlabServer, allPageUrls };
+export { gitlabServer, allPageUrls, allUserPageUrls };
 //#endregion
 
 /**

src/templates/snek/gql/queries/user.ts

@@ -17,27 +17,22 @@ const whoami = gql`
   query whoami($token: String!) {
     whoami: me(token: $token) {
       username
-      firstName
-      lastName
-      email
-      dateJoined
-      lastLogin
     }
   }
 `;
 
 /**
  * Get user profile.
  *
- * @param {string} url PageUrl of a user profile
+ * @param {string} slug Slug: <user_<username>>
  * @param {string} token A users JWT
  * @returns {string} A profile page of a user
  * @description A query to fetch profile data
  */
 const profile = gql`
-  query profile($url: String!, $token: String!) {
-    profile: page(url: $url, token: $token) {
-      ... on ProfileProfilePage {
+  query profile($slug: String!, $token: String!) {
+    profile: page(slug: $slug, token: $token) {
+      ... on ProfilePage {
         username
         firstName
         lastName

src/templates/snek/gql/tasks/auth.ts

@@ -8,6 +8,8 @@ import { User } from "../../../../session";
 //> Types
 // Contains the type declarations for Apollo results
 import { ApolloResult } from "./index";
+//> Config
+import Config from "../../../../config.json";
 //#endregion
 
 //#region > Interfaces
@@ -68,8 +70,8 @@ class SnekGqlAuthTasks {
       "mutation",
       this.parent.template.mutations.jwtAuth.auth,
       {
-        username: "cisco",
-        password: "ciscocisco",
+        username: Config.anonUser.username,
+        password: Config.anonUser.password,
       }
     );
 

src/templates/snek/gql/tasks/general.ts

@@ -14,7 +14,7 @@ import { ApolloResult } from "./index";
  */
 interface GitlabServerData {
   page: {
-    supportedGitlabs: [];
+    supportedGitlabs: { id: string; organisation: string; domain: string; }[];
   };
 }
 
@@ -23,7 +23,15 @@ interface GitlabServerData {
  *                           data.
  */
 interface AllPageUrlData {
-  pages: [];
+  pages: { urlPath: string }[];
+}
+
+/**
+ * @interface AllUserPageUrlsData defines the types of the response of the
+ *                                allUserPageUrls query.  
+ */
+interface AllUserPageUrlsData {
+  page: { children: { url: string }[] };
 }
 //#endregion
 
@@ -36,7 +44,7 @@ class SnekGqlGeneralTasks {
    * @author Nico Schett <contact@schett.net>
    * @param {string} parent The parent task
    */
-  constructor(private parent: SnekTasks) {}
+  constructor(private parent: SnekTasks) { }
 
   /**
    * Gitlab Server.
@@ -73,6 +81,25 @@ class SnekGqlGeneralTasks {
 
     return response;
   }
+
+  /**
+   * All user page urls.
+   *
+   * @returns {Promise<ApolloResult<AllUserPageUrlsData>>} A list of all user
+   *                                                       page urls.
+   * @description Get a list of all pages
+   */
+  async allUserPageUrls(): Promise<ApolloResult<AllUserPageUrlsData>> {
+    const response = await this.parent.run<AllUserPageUrlsData>(
+      "query",
+      this.parent.template.queries.general.allUserPageUrls,
+      {
+        token: await this.parent.session.upToDateToken(),
+      }
+    );
+
+    return response;
+  }
 }
 //#endregion
 

src/templates/snek/gql/tasks/user.ts

@@ -106,15 +106,15 @@ class SnekGqlUserTasks {
   /**
    * Get profile.
    *
-   * @param {string} url A url of a page
+   * @param {string} slug Slug: <user_<username>>
    * @returns {Promise<ApolloResult<ProfileData>>} The profile page of a user
    */
-  async profile(url: string): Promise<ApolloResult<ProfileData>> {
+  async profile(slug: string): Promise<ApolloResult<ProfileData>> {
     const response = await this.parent.run<ProfileData>(
       "query",
       this.parent.template.queries.user.profile,
       {
-        url,
+        slug,
         token: await this.parent.session.upToDateToken(),
       }
     );