moos-api - npm Package Compare versions

Comparing version 0.4.2 to 0.5.0

package.json

 {
   "name": "moos-api",
-  "version": "0.4.2",
+  "version": "0.5.0",
   "description": "Moos API type definitions",
@@ -19,3 +19,3 @@ "repository": {
     "@typescript-eslint/parser": "^5.30.6",
-    "eslint": "^8.19.0",
+    "eslint": "^8.20.0",
     "eslint-config-prettier": "^8.5.0",
@@ -22,0 +22,0 @@ "husky": "^8.0.1",

reference/moos-api-v1.ts

@@ -8,16 +8,68 @@ /**
   "/profile": {
-    /** Get your own Profile, if you are logged in with a session cookie */
+    /** Get your own Profile. */
     post: operations["fetch-profile"];
-    /** Update your own Profile information, if you are logged in with a session cookie */
+    /** Update your own Profile information. */
     patch: operations["patch-profile"];
   };
-  "/profile/known": {
-    /** Know a person */
-    put: operations["put-profile-known"];
-    /** Get the profile of a known person. */
-    post: operations["post-profile-known"];
-    /** Stop knowing a person */
-    delete: operations["delete-profile-known"];
+  "/profile/applications": {
+    /** Get a list of your applications. */
+    post: operations["post-profile-applications"];
     parameters: {};
   };
+  "/profile/friends": {
+    /** Get a list of your friends. */
+    post: operations["post-profile-friends"];
+    parameters: {};
+  };
+  "/profile/friend/{friendId}": {
+    /** Begin a friendship. */
+    put: operations["put-profile-friend"];
+    /** End a friendship. */
+    delete: operations["delete-profile-friend"];
+    parameters: {
+      path: {
+        friendId: string;
+      };
+    };
+  };
+  "/profile/friend/{friendId}/applications": {
+    /** Get a list of the applications of a friend, which you are allowed to see. */
+    post: operations["post-profile-friend-applications"];
+    parameters: {
+      path: {
+        friendId: string;
+      };
+    };
+  };
+  "/profile/friend/{friendId}/files": {
+    /** Get a list of the files of a friend, which you are allowed to see. */
+    post: operations["post-profile-friend-files"];
+    parameters: {
+      path: {
+        friendId: string;
+      };
+    };
+  };
+  "/profile/friend/{friendId}/collections": {
+    /** Get a list of the collections of a friend, which you are allowed to see. */
+    post: operations["post-profile-friend-collections"];
+    parameters: {
+      path: {
+        friendId: string;
+      };
+    };
+  };
+  "/profile/friend/{friendId}/friends": {
+    /** Get a list of the friends of a friend, which you are allowed to see. */
+    post: operations["post-profile-friend-friends"];
+    parameters: {
+      path: {
+        friendId: string;
+      };
+    };
+  };
+  "/profile/files": {
+    /** Get a list of your own files. */
+    post: operations["post-profile-files"];
+  };
   "/profile/file": {
@@ -27,3 +79,3 @@ /** Request a pre-signed upload url for a file you want to upload, if you are logged in with a session cookie. */
     /** Request a pre-signed download url for a file you want to download, if you are logged in with a session cookie. */
-    post: operations["get-profile-file"];
+    post: operations["post-profile-file"];
     /** Delete the file selected with the id parameter, if you are logged in with a session cookie. */
@@ -35,5 +87,6 @@ delete: operations["delete-profile-file"];
   };
-  "/profile/files": {
-    /** Get a list of your own files, if you are logged in with a session cookie */
-    post: operations["get-profile-files"];
+  "/profile/collections": {
+    /** Get a list of your own files. */
+    post: operations["post-profile-collections"];
+    parameters: {};
   };
@@ -46,7 +99,7 @@ "/profile/collection": {
   };
-  "/profile/list": {
-    put: operations["put-profile-list"];
-    post: operations["post-profile-list"];
-    delete: operations["delete-profile-list"];
-    patch: operations["patch-profile-list"];
+  "/profile/season": {
+    put: operations["put-profile-season"];
+    post: operations["post-profile-season"];
+    delete: operations["delete-profile-season"];
+    patch: operations["patch-profile-season"];
     parameters: {};
@@ -99,11 +152,7 @@ };
       providers?: components["schemas"]["ProviderProfile"][];
-      applications?: string[];
-      files?: string[];
-      collections?: string[];
-      known?: string[];
       /** Format: int64 */
       creationDate: number;
     };
-    /** known-profile */
-    KnownUser: {
+    /** friend */
+    Friend: {
       /** Format: uuid */
@@ -117,7 +166,3 @@ uid: string;
       private: boolean;
-      providers?: components["schemas"]["ProviderProfile"][];
-      applications?: string[];
-      files?: string[];
-      collections?: string[];
-      known?: string[];
+      consensual: boolean;
       /** Format: int64 */
@@ -214,4 +259,4 @@ creationDate: number;
     };
-    /** season-group */
-    SeasonGroup: {
+    /** collection */
+    Collection: {
       /** Format: uuid */
@@ -226,3 +271,3 @@ id: string;
       seasons: string[];
-      /** Format: uuid */
+      /** Format: uri */
       thumbnail?: string;
@@ -238,3 +283,3 @@ owner: string;
 export interface operations {
-  /** Get your own Profile, if you are logged in with a session cookie */
+  /** Get your own Profile. */
   "fetch-profile": {
@@ -256,3 +301,3 @@ responses: {
   };
-  /** Update your own Profile information, if you are logged in with a session cookie */
+  /** Update your own Profile information. */
   "patch-profile": {
@@ -279,6 +324,46 @@ responses: {
   };
-  /** Know a person */
-  "put-profile-known": {
+  /** Get a list of your applications. */
+  "post-profile-applications": {
     parameters: {};
     responses: {
+      /** OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["Application"][];
+        };
+      };
+      /** Unauthorized */
+      401: unknown;
+      /** Forbidden */
+      403: unknown;
+      /** Internal Server Error */
+      500: unknown;
+    };
+  };
+  /** Get a list of your friends. */
+  "post-profile-friends": {
+    parameters: {};
+    responses: {
+      /** OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["Friend"][];
+        };
+      };
+      /** Unauthorized */
+      401: unknown;
+      /** Forbidden */
+      403: unknown;
+      /** Internal Server Error */
+      500: unknown;
+    };
+  };
+  /** Begin a friendship. */
+  "put-profile-friend": {
+    parameters: {
+      path: {
+        friendId: string;
+      };
+    };
+    responses: {
       /** Created */
@@ -297,17 +382,58 @@ 201: unknown;
     };
-    requestBody: {
-      content: {
-        "application/json": {
-          /**
-           * Format: uuid
-           * @default true
-           */
-          uid: string;
+  };
+  /** End a friendship. */
+  "delete-profile-friend": {
+    parameters: {
+      path: {
+        friendId: string;
+      };
+    };
+    responses: {
+      /** No Content */
+      204: never;
+      /** Bad Request */
+      400: unknown;
+      /** Unauthorized */
+      401: unknown;
+      /** Invalid CSRF Token */
+      403: unknown;
+      /** Not Found */
+      404: unknown;
+      /** Internal Server Error */
+      500: unknown;
+    };
+  };
+  /** Get a list of the applications of a friend, which you are allowed to see. */
+  "post-profile-friend-applications": {
+    parameters: {
+      path: {
+        friendId: string;
+      };
+    };
+    responses: {
+      /** OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["Application"][];
         };
       };
+      /** Bad Request */
+      400: unknown;
+      /** Unauthorized */
+      401: unknown;
+      /** Forbidden */
+      403: unknown;
+      /** Not Found */
+      404: unknown;
+      /** Internal Server Error */
+      500: unknown;
     };
   };
-  /** Get the profile of a known person. */
-  "post-profile-known": {
-    parameters: {};
+  /** Get a list of the files of a friend, which you are allowed to see. */
+  "post-profile-friend-files": {
+    parameters: {
+      path: {
+        friendId: string;
+      };
+    };
     responses: {
@@ -317,3 +443,3 @@ /** OK */
         content: {
-          "application/json": components["schemas"]["KnownUser"];
+          "application/json": components["schemas"]["File"][];
         };
@@ -332,20 +458,43 @@ };
     };
-    requestBody: {
-      content: {
-        "application/json": {
-          /**
-           * Format: uuid
-           * @default true
-           */
-          uid: string;
+  };
+  /** Get a list of the collections of a friend, which you are allowed to see. */
+  "post-profile-friend-collections": {
+    parameters: {
+      path: {
+        friendId: string;
+      };
+    };
+    responses: {
+      /** OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["Collection"][];
         };
       };
+      /** Bad Request */
+      400: unknown;
+      /** Unauthorized */
+      401: unknown;
+      /** Forbidden */
+      403: unknown;
+      /** Not Found */
+      404: unknown;
+      /** Internal Server Error */
+      500: unknown;
     };
   };
-  /** Stop knowing a person */
-  "delete-profile-known": {
-    parameters: {};
+  /** Get a list of the friends of a friend, which you are allowed to see. */
+  "post-profile-friend-friends": {
+    parameters: {
+      path: {
+        friendId: string;
+      };
+    };
     responses: {
-      /** No Content */
-      204: never;
+      /** OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["Friend"][];
+        };
+      };
       /** Bad Request */
@@ -355,3 +504,3 @@ 400: unknown;
       401: unknown;
-      /** Invalid CSRF Token */
+      /** Forbidden */
       403: unknown;
@@ -363,9 +512,18 @@ /** Not Found */
     };
-    requestBody: {
-      content: {
-        "application/json": {
-          /** Format: uuid */
-          uid: string;
+  };
+  /** Get a list of your own files. */
+  "post-profile-files": {
+    responses: {
+      /** OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["File"][];
         };
       };
+      /** Unauthorized */
+      401: unknown;
+      /** Forbidden */
+      403: unknown;
+      /** Internal Server Error */
+      500: unknown;
     };
@@ -410,3 +568,3 @@ };
   /** Request a pre-signed download url for a file you want to download, if you are logged in with a session cookie. */
-  "get-profile-file": {
+  "post-profile-file": {
     parameters: {};
@@ -425,3 +583,2 @@ responses: {
           };
-          "application/xml": components["schemas"]["File"];
         };
@@ -508,4 +665,5 @@ };
   };
-  /** Get a list of your own files, if you are logged in with a session cookie */
-  "get-profile-files": {
+  /** Get a list of your own files. */
+  "post-profile-collections": {
+    parameters: {};
     responses: {
@@ -515,3 +673,3 @@ /** OK */
         content: {
-          "application/json": components["schemas"]["File"][];
+          "application/json": components["schemas"]["Collection"][];
         };
@@ -521,2 +679,4 @@ };
       401: unknown;
+      /** Forbidden */
+      403: unknown;
       /** Internal Server Error */
@@ -531,3 +691,3 @@ 500: unknown;
         content: {
-          "application/json": components["schemas"]["SeasonGroup"];
+          "application/json": components["schemas"]["Collection"];
         };
@@ -553,3 +713,3 @@ };
           visibility?: "private" | "public" | "unlisted";
-          /** Format: uri */
+          /** Format: uuid */
           thumbnail?: string;
@@ -565,3 +725,3 @@ };
         content: {
-          "application/json": components["schemas"]["SeasonGroup"];
+          "application/json": components["schemas"]["Collection"];
         };
@@ -642,3 +802,3 @@ };
   };
-  "put-profile-list": {
+  "put-profile-season": {
     parameters: {};
@@ -667,3 +827,3 @@ responses: {
           /** Format: uuid */
-          groupId: string;
+          collectionId: string;
           index: number;
@@ -674,3 +834,3 @@ };
   };
-  "post-profile-list": {
+  "post-profile-season": {
     parameters: {};
@@ -704,3 +864,3 @@ responses: {
   };
-  "delete-profile-list": {
+  "delete-profile-season": {
     parameters: {};
@@ -730,3 +890,3 @@ responses: {
   };
-  "patch-profile-list": {
+  "patch-profile-season": {
     parameters: {};
@@ -733,0 +893,0 @@ responses: {

types/index.ts

@@ -15,7 +15,7 @@ import { components as _components, external as _external, operations as _operations, paths as _paths } from "../reference/moos-api-v1";
   export type UserProfile = _components["schemas"]["UserProfile"];
-  export type KnownUserProfile = _components["schemas"]["KnownUser"];
+  export type Friend = _components["schemas"]["Friend"];
   export type ProviderProfile = _components["schemas"]["ProviderProfile"];
   export type Application = _components["schemas"]["Application"];
   export type File = _components["schemas"]["File"];
-  export type SeasonGroup = _components["schemas"]["SeasonGroup"];
+  export type Collection = _components["schemas"]["Collection"];
   export type Season = _components["schemas"]["Season"];
@@ -22,0 +22,0 @@ export type Language = _components["schemas"]["Language"];

No alert changes

Improved metrics

Total package byte prevSize

154026

4.11%

Lines of code

1257

14.59%

No dependency changes