moos-api - npm Package Compare versions

Comparing version 0.7.2 to 0.7.3

package.json

 {
   "name": "moos-api",
-  "version": "0.7.2",
+  "version": "0.7.3",
   "description": "Moos API type definitions",
@@ -28,3 +28,6 @@ "repository": {
   "lint-staged": {
-    "*.yaml": "openapi-typescript \"reference/**/*.yaml\" --output .",
+    "*.yaml": [
+      "prettier --write",
+      "openapi-typescript \"reference/**/*.yaml\" --export-type --output ."
+    ],
     "*.{js,ts}": "eslint --ext ts --cache --fix",
@@ -34,3 +37,3 @@ "*.{js,ts,css,md,json}": "prettier --write"
   "scripts": {
-    "openapi": "openapi-typescript \"reference/**/*.yaml\" --output .",
+    "openapi": "openapi-typescript \"reference/**/*.yaml\" --additional-properties --export-type --output .",
     "lint": "eslint --ext ts .",
@@ -37,0 +40,0 @@ "lint:fix": "yarn lint --fix",

reference/cdn-api-v1.ts

@@ -6,11 +6,12 @@ /**
 
+
 /** Type helpers */
 type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };
-type XOR<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
+type XOR<T, U> = (T | U) extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
 type OneOf<T extends any[]> = T extends [infer Only] ? Only : T extends [infer A, infer B, ...infer Rest] ? OneOf<[XOR<A, B>, ...Rest]> : never;
 
-export interface paths {
+export type paths = {
   "/profile": {
     /**
-     * Fetch Profile
+     * Fetch Profile 
      * @description Get your own Profile.
@@ -24,3 +25,3 @@ */
     /**
-     * Create File
+     * Create File 
      * @description Request a pre-signed upload url for a file you want to upload, if you are logged in with a session cookie and have permission.
@@ -30,3 +31,3 @@ */
     /**
-     * Get File
+     * Get File 
      * @description Request a pre-signed download url for a file you want to download, if you are logged in with a session cookie and have permission.
@@ -36,3 +37,3 @@ */
     /**
-     * Delete File
+     * Delete File 
      * @description Delete the file selected with the id parameter, if you are logged in with a session cookie and have permission.
@@ -42,3 +43,3 @@ */
     /**
-     * Patch File Metadata
+     * Patch File Metadata 
      * @description Update the metadata of one of your files, if you are logged in with a session cookie and have permission.
@@ -50,3 +51,3 @@ */
     /**
-     * List all Collections
+     * List all Collections 
      * @description Get a list of the collections, which you are allowed to see.
@@ -106,5 +107,5 @@ */
   };
-}
+};
 
-export interface components {
+export type components = {
   schemas: {
@@ -146,4 +147,4 @@ /** profile */
       name: string;
-      sources: components["schemas"]["Source"][];
-      subtitles: components["schemas"]["Source"][];
+      sources: (components["schemas"]["Source"])[];
+      subtitles: (components["schemas"]["Source"])[];
       /** Format: int64 */
@@ -183,5 +184,5 @@ creationDate: number;
     /**
-     * language
-     * @default en_EN
-     * @example de_DE
+     * language 
+     * @default en_EN 
+     * @example de_DE 
      * @enum {string}
@@ -197,5 +198,5 @@ */
       index: number;
-      episodes: components["schemas"]["Episode"][];
-      languages: components["schemas"]["Language"][];
-      subtitles: components["schemas"]["Language"][];
+      episodes: (components["schemas"]["Episode"])[];
+      languages: (components["schemas"]["Language"])[];
+      subtitles: (components["schemas"]["Language"])[];
     };
@@ -208,7 +209,7 @@ /** collection */
       /**
-       * @default private
+       * @default private 
        * @enum {string}
        */
       visibility: "private" | "public" | "unlisted";
-      seasons: components["schemas"]["Season"][];
+      seasons: (components["schemas"]["Season"])[];
       owner: string;
@@ -224,3 +225,3 @@ /** Format: int64 */
       /**
-       * @default private
+       * @default private 
        * @enum {string}
@@ -238,13 +239,15 @@ */
   parameters: never;
-  requestBodies: {};
+  requestBodies: {
+  };
   headers: never;
   pathItems: never;
-}
+};
 
 export type external = Record<string, never>;
 
-export interface operations {
+export type operations = {
+
   "fetch-profile": {
     /**
-     * Fetch Profile
+     * Fetch Profile 
      * @description Get your own Profile.
@@ -284,6 +287,6 @@ */
     /**
-     * Create File
+     * Create File 
      * @description Request a pre-signed upload url for a file you want to upload, if you are logged in with a session cookie and have permission.
      */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -323,6 +326,6 @@ "application/json": {
     /**
-     * Get File
+     * Get File 
      * @description Request a pre-signed download url for a file you want to download, if you are logged in with a session cookie and have permission.
      */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -333,3 +336,3 @@ "application/json": {
           /**
-           * Format: int64
+           * Format: int64 
            * @default 14400
@@ -369,6 +372,6 @@ */
     /**
-     * Delete File
+     * Delete File 
      * @description Delete the file selected with the id parameter, if you are logged in with a session cookie and have permission.
      */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -398,6 +401,6 @@ "application/json": {
     /**
-     * Patch File Metadata
+     * Patch File Metadata 
      * @description Update the metadata of one of your files, if you are logged in with a session cookie and have permission.
      */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -429,3 +432,3 @@ "application/json": {
     /**
-     * List all Collections
+     * List all Collections 
      * @description Get a list of the collections, which you are allowed to see.
@@ -437,3 +440,3 @@ */
         content: {
-          "application/json": components["schemas"]["CollectionPreview"][];
+          "application/json": (components["schemas"]["CollectionPreview"])[];
         };
@@ -451,3 +454,3 @@ };
     /** Create Collection */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -457,3 +460,3 @@ "application/json": {
           /**
-           * @default private
+           * @default private 
            * @enum {string}
@@ -486,3 +489,3 @@ */
     /** Get Collection */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -516,3 +519,3 @@ "application/json": {
     /** Delete Collection */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -542,3 +545,3 @@ "application/json": {
     /** Patch Collection */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -573,3 +576,3 @@ "application/json": {
     /** Create Season */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -604,3 +607,3 @@ "application/json": {
     /** Get Season */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -634,3 +637,3 @@ "application/json": {
     /** Delete Season */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -660,3 +663,3 @@ "application/json": {
     /** Patch Season */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -687,3 +690,3 @@ "application/json": {
     /** Create Episode */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -719,3 +722,3 @@ "application/json": {
     /** Get Episode */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -751,3 +754,3 @@ "application/json": {
     /** Delete Episode */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -778,3 +781,3 @@ "application/json": {
     /** Patch Episode */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -808,3 +811,3 @@ "application/json": {
     /** Create Source */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -844,3 +847,3 @@ "application/json": {
     /** Get Source */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -877,3 +880,3 @@ "application/json": {
     /** Delete Source */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -907,3 +910,3 @@ "application/json": {
     /** Patch Source */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -941,3 +944,3 @@ "application/json": {
     /** Create Subtitle */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -976,3 +979,3 @@ "application/json": {
     /** Get Subtitle */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -1009,3 +1012,3 @@ "application/json": {
     /** Delete Subtitle */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -1039,3 +1042,3 @@ "application/json": {
     /** Patch Subtitle */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -1070,2 +1073,2 @@ "application/json": {
   };
-}
+};

reference/moos-api-v1.ts

@@ -6,11 +6,12 @@ /**
 
+
 /** Type helpers */
 type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };
-type XOR<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
+type XOR<T, U> = (T | U) extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
 type OneOf<T extends any[]> = T extends [infer Only] ? Only : T extends [infer A, infer B, ...infer Rest] ? OneOf<[XOR<A, B>, ...Rest]> : never;
 
-export interface paths {
+export type paths = {
   "/profile": {
     /**
-     * Fetch Profile
+     * Fetch Profile 
      * @description Get your own Profile.
@@ -20,3 +21,3 @@ */
     /**
-     * Patch Profile
+     * Patch Profile 
      * @description Update your own Profile information.
@@ -28,3 +29,3 @@ */
     /**
-     * Fetch Applications
+     * Fetch Applications 
      * @description Get a list of your applications.
@@ -36,3 +37,3 @@ */
     /**
-     * Fetch Profile of a friend
+     * Fetch Profile of a friend 
      * @description Get a list of your friends.
@@ -44,3 +45,3 @@ */
     /**
-     * Add Friend
+     * Add Friend 
      * @description Begin a friendship.
@@ -50,3 +51,3 @@ */
     /**
-     * Remove Friend
+     * Remove Friend 
      * @description End a friendship.
@@ -63,3 +64,3 @@ */
     /**
-     * List all Applications of a friend
+     * List all Applications of a friend 
      * @description Get a list of the applications of a friend, which you are allowed to see.
@@ -76,3 +77,3 @@ */
     /**
-     * List all Files of a friend
+     * List all Files of a friend 
      * @description Get a list of the files of a friend, which you are allowed to see.
@@ -89,3 +90,3 @@ */
     /**
-     * List all Friends of a friend
+     * List all Friends of a friend 
      * @description Get a list of the friends of a friend, which you are allowed to see.
@@ -102,3 +103,3 @@ */
     /**
-     * List all Files
+     * List all Files 
      * @description Get a list of your own files.
@@ -110,3 +111,3 @@ */
     /**
-     * Create File
+     * Create File 
      * @description Request a pre-signed upload url for a file you want to upload, if you are logged in with a session cookie.
@@ -116,3 +117,3 @@ */
     /**
-     * Get File
+     * Get File 
      * @description Request a pre-signed download url for a file you want to download, if you are logged in with a session cookie.
@@ -122,3 +123,3 @@ */
     /**
-     * Delete File
+     * Delete File 
      * @description Delete the file selected with the id parameter, if you are logged in with a session cookie.
@@ -128,3 +129,3 @@ */
     /**
-     * Patch File Metadata
+     * Patch File Metadata 
      * @description Update the metadata of one of your files, if you are logged in with a session cookie.
@@ -136,3 +137,3 @@ */
     /**
-     * Request CSRF-Token
+     * Request CSRF-Token 
      * @description Endpoint for requesting the CSRF Token
@@ -142,3 +143,3 @@ */
     /**
-     * Test CSRF-Token
+     * Test CSRF-Token 
      * @description Endpoint for testing the CSRF Token
@@ -150,3 +151,3 @@ */
     /**
-     * Request Session
+     * Request Session 
      * @description Endpoint for requesting a session cookie
@@ -156,3 +157,3 @@ */
     /**
-     * Revoke Session
+     * Revoke Session 
      * @description Endpoint for revoking a session cookie
@@ -164,3 +165,3 @@ */
     /**
-     * Fetch User Profile
+     * Fetch User Profile 
      * @description Fetch profile associated with the bearer token.
@@ -170,5 +171,5 @@ */
   };
-}
+};
 
-export interface components {
+export type components = {
   schemas: {
@@ -182,6 +183,6 @@ /** profile */
       avatar: OneOf<[string, null]>;
-      scopes: "*"[];
+      scopes: ("*")[];
       /** @default false */
       private: boolean;
-      providers?: components["schemas"]["ProviderProfile"][];
+      providers?: (components["schemas"]["ProviderProfile"])[];
       /** Format: int64 */
@@ -197,3 +198,3 @@ creationDate: number;
       avatar: OneOf<[string, null]>;
-      scopes?: "*"[];
+      scopes?: ("*")[];
       /** @default false */
@@ -248,13 +249,15 @@ private: boolean;
   parameters: never;
-  requestBodies: {};
+  requestBodies: {
+  };
   headers: never;
   pathItems: never;
-}
+};
 
 export type external = Record<string, never>;
 
-export interface operations {
+export type operations = {
+
   "fetch-profile": {
     /**
-     * Fetch Profile
+     * Fetch Profile 
      * @description Get your own Profile.
@@ -279,6 +282,6 @@ */
     /**
-     * Patch Profile
+     * Patch Profile 
      * @description Update your own Profile information.
      */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -305,3 +308,3 @@ "application/json": {
     /**
-     * Fetch Applications
+     * Fetch Applications 
      * @description Get a list of your applications.
@@ -313,3 +316,3 @@ */
         content: {
-          "application/json": components["schemas"]["Application"][];
+          "application/json": (components["schemas"]["Application"])[];
         };
@@ -327,3 +330,3 @@ };
     /**
-     * Fetch Profile of a friend
+     * Fetch Profile of a friend 
      * @description Get a list of your friends.
@@ -335,3 +338,3 @@ */
         content: {
-          "application/json": components["schemas"]["Friend"][];
+          "application/json": (components["schemas"]["Friend"])[];
         };
@@ -349,3 +352,3 @@ };
     /**
-     * Add Friend
+     * Add Friend 
      * @description Begin a friendship.
@@ -370,3 +373,3 @@ */
     /**
-     * Remove Friend
+     * Remove Friend 
      * @description End a friendship.
@@ -391,3 +394,3 @@ */
     /**
-     * List all Applications of a friend
+     * List all Applications of a friend 
      * @description Get a list of the applications of a friend, which you are allowed to see.
@@ -399,3 +402,3 @@ */
         content: {
-          "application/json": components["schemas"]["Application"][];
+          "application/json": (components["schemas"]["Application"])[];
         };
@@ -417,3 +420,3 @@ };
     /**
-     * List all Files of a friend
+     * List all Files of a friend 
      * @description Get a list of the files of a friend, which you are allowed to see.
@@ -425,3 +428,3 @@ */
         content: {
-          "application/json": components["schemas"]["File"][];
+          "application/json": (components["schemas"]["File"])[];
         };
@@ -443,3 +446,3 @@ };
     /**
-     * List all Friends of a friend
+     * List all Friends of a friend 
      * @description Get a list of the friends of a friend, which you are allowed to see.
@@ -451,3 +454,3 @@ */
         content: {
-          "application/json": components["schemas"]["Friend"][];
+          "application/json": (components["schemas"]["Friend"])[];
         };
@@ -469,3 +472,3 @@ };
     /**
-     * List all Files
+     * List all Files 
      * @description Get a list of your own files.
@@ -477,3 +480,3 @@ */
         content: {
-          "application/json": components["schemas"]["File"][];
+          "application/json": (components["schemas"]["File"])[];
         };
@@ -491,6 +494,6 @@ };
     /**
-     * Create File
+     * Create File 
      * @description Request a pre-signed upload url for a file you want to upload, if you are logged in with a session cookie.
      */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -530,6 +533,6 @@ "application/json": {
     /**
-     * Get File
+     * Get File 
      * @description Request a pre-signed download url for a file you want to download, if you are logged in with a session cookie.
      */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -540,3 +543,3 @@ "application/json": {
           /**
-           * Format: int64
+           * Format: int64 
            * @default 14400
@@ -576,6 +579,6 @@ */
     /**
-     * Delete File
+     * Delete File 
      * @description Delete the file selected with the id parameter, if you are logged in with a session cookie.
      */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -605,6 +608,6 @@ "application/json": {
     /**
-     * Patch File Metadata
+     * Patch File Metadata 
      * @description Update the metadata of one of your files, if you are logged in with a session cookie.
      */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -636,3 +639,3 @@ "application/json": {
     /**
-     * Request CSRF-Token
+     * Request CSRF-Token 
      * @description Endpoint for requesting the CSRF Token
@@ -653,3 +656,3 @@ */
     /**
-     * Test CSRF-Token
+     * Test CSRF-Token 
      * @description Endpoint for testing the CSRF Token
@@ -666,6 +669,6 @@ */
     /**
-     * Request Session
+     * Request Session 
      * @description Endpoint for requesting a session cookie
      */
-    requestBody?: {
+    requestBody: {
       content: {
@@ -688,3 +691,3 @@ "application/json": {
     /**
-     * Revoke Session
+     * Revoke Session 
      * @description Endpoint for revoking a session cookie
@@ -703,3 +706,3 @@ */
     /**
-     * Fetch User Profile
+     * Fetch User Profile 
      * @description Fetch profile associated with the bearer token.
@@ -718,2 +721,2 @@ */
   };
-}
+};

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

136774

increased by0.62%

Lines of code

1760

increased by0.11%

No dependency changes