lemmy-js-client 0.20.0-api-v4.16 → 0.20.0-image-api-rework.0

package/dist/http.d.ts

@@ -123,7 +123,7 @@ import { SearchResponse } from "./types/SearchResponse";
 import { SiteResponse } from "./types/SiteResponse";
 import { TransferCommunity } from "./types/TransferCommunity";
 import { VerifyEmail } from "./types/VerifyEmail";
-import { DeleteImage, UploadImage, UploadImageResponse } from "./other_types";
+import { UploadImage } from "./other_types";
 import { HideCommunity } from "./types/HideCommunity";
 import { GenerateTotpSecretResponse } from "./types/GenerateTotpSecretResponse";
 import { UpdateTotp } from "./types/UpdateTotp";
@@ -157,6 +157,8 @@ import { MyUserInfo } from "./types/MyUserInfo";
 import { UserBlockInstanceParams } from "./types/UserBlockInstanceParams";
 import { AdminAllowInstanceParams } from "./types/AdminAllowInstanceParams";
 import { AdminBlockInstanceParams } from "./types/AdminBlockInstanceParams";
+import { DeleteImageParams } from "./types/DeleteImageParams";
+import { UploadImageResponse } from "./types/UploadImageResponse";
 type RequestOptions = Pick<RequestInit, "signal">;
 /**
  * Helps build lemmy HTTP requests.
@@ -876,12 +878,28 @@ export declare class LemmyHttp {
     adminAllowInstance(form: AdminAllowInstanceParams, options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * Upload an image to the server.
+     *
+     * `HTTP.Post /image`
      */
     uploadImage({ image }: UploadImage, options?: RequestOptions): Promise<UploadImageResponse>;
+    /**
+     * Upload new user avatar.
+     *
+     * `HTTP.Post /account/avatar`
+     */
+    userUploadAvatar({ image }: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * Delete a pictrs image
+     *
+     * `HTTP.Delete /image`
+     */
+    deleteImage(form: DeleteImageParams, options?: RequestOptions): Promise<SuccessResponse>;
+    /**
+     * Health check for image functionality
+     *
+     * `HTTP.Get /image/health`
      */
-    deleteImage({ token, filename }: DeleteImage, options?: RequestOptions): Promise<boolean>;
+    imageHealth(options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * Set the headers (can be used to set the auth header)
      */

package/dist/http.js

@@ -28,6 +28,7 @@ var HttpType;
     HttpType["Get"] = "GET";
     HttpType["Post"] = "POST";
     HttpType["Put"] = "PUT";
+    HttpType["Delete"] = "DELETE";
 })(HttpType || (HttpType = {}));
 /**
  * Helps build lemmy HTTP requests.
@@ -992,34 +993,46 @@ class LemmyHttp {
     }
     /**
      * Upload an image to the server.
+     *
+     * `HTTP.Post /image`
      */
     uploadImage(_a, options_1) {
         return __awaiter(this, arguments, void 0, function* ({ image }, options) {
             const formData = createFormData(image);
-            let url = undefined;
-            let delete_url = undefined;
             const response = yield __classPrivateFieldGet(this, _LemmyHttp_fetchFunction, "f").call(this, __classPrivateFieldGet(this, _LemmyHttp_pictrsUrl, "f"), Object.assign(Object.assign({}, options), { method: HttpType.Post, body: formData, headers: __classPrivateFieldGet(this, _LemmyHttp_headers, "f") }));
-            if (response.status === 413) {
-                return { msg: "too_large" };
-            }
-            const responseJson = yield response.json();
-            if (responseJson.msg === "ok") {
-                const { file: hash, delete_token: deleteToken } = responseJson.files[0];
-                delete_url = `${__classPrivateFieldGet(this, _LemmyHttp_pictrsUrl, "f")}/delete/${deleteToken}/${hash}`;
-                url = `${__classPrivateFieldGet(this, _LemmyHttp_pictrsUrl, "f")}/${hash}`;
-            }
-            return Object.assign(Object.assign({}, responseJson), { url,
-                delete_url });
+            return response.json();
+        });
+    }
+    /**
+     * Upload new user avatar.
+     *
+     * `HTTP.Post /account/avatar`
+     */
+    userUploadAvatar(_a, options_1) {
+        return __awaiter(this, arguments, void 0, function* ({ image }, options) {
+            const formData = createFormData(image);
+            const response = yield __classPrivateFieldGet(this, _LemmyHttp_fetchFunction, "f").call(this, __classPrivateFieldGet(this, _LemmyHttp_pictrsUrl, "f"), Object.assign(Object.assign({}, options), { method: HttpType.Post, body: formData, headers: __classPrivateFieldGet(this, _LemmyHttp_headers, "f") }));
+            return response.json();
         });
     }
     /**
      * Delete a pictrs image
+     *
+     * `HTTP.Delete /image`
+     */
+    deleteImage(form, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Delete, "/image", form, options);
+        });
+    }
+    /**
+     * Health check for image functionality
+     *
+     * `HTTP.Get /image/health`
      */
-    deleteImage(_a, options_1) {
-        return __awaiter(this, arguments, void 0, function* ({ token, filename }, options) {
-            const deleteUrl = `${__classPrivateFieldGet(this, _LemmyHttp_pictrsUrl, "f")}/delete/${token}/${filename}`;
-            const response = yield __classPrivateFieldGet(this, _LemmyHttp_fetchFunction, "f").call(this, deleteUrl, Object.assign(Object.assign({}, options), { method: HttpType.Get, headers: __classPrivateFieldGet(this, _LemmyHttp_headers, "f") }));
-            return response.status == 204;
+    imageHealth(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Get, "/image/health", {}, options);
         });
     }
     /**

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export * from "./http";
-export { UploadImage, UploadImageResponse, ImageFile, DeleteImage, } from "./other_types";
+export { UploadImage } from "./other_types";
 export { ActivityId } from "./types/ActivityId";
 export { AddAdmin } from "./types/AddAdmin";
 export { AddAdminResponse } from "./types/AddAdminResponse";
@@ -80,6 +80,7 @@ export { DeleteAccount } from "./types/DeleteAccount";
 export { DeleteComment } from "./types/DeleteComment";
 export { DeleteCommunity } from "./types/DeleteCommunity";
 export { DeleteCustomEmoji } from "./types/DeleteCustomEmoji";
+export { DeleteImageParams } from "./types/DeleteImageParams";
 export { DeleteOAuthProvider } from "./types/DeleteOAuthProvider";
 export { DeletePost } from "./types/DeletePost";
 export { DeletePrivateMessage } from "./types/DeletePrivateMessage";
@@ -133,6 +134,8 @@ export { GetUnreadRegistrationApplicationCountResponse } from "./types/GetUnread
 export { HideCommunity } from "./types/HideCommunity";
 export { HidePost } from "./types/HidePost";
 export { ImageDetails } from "./types/ImageDetails";
+export { ImageGetParams } from "./types/ImageGetParams";
+export { ImageProxyParams } from "./types/ImageProxyParams";
 export { Instance } from "./types/Instance";
 export { InstanceId } from "./types/InstanceId";
 export { InstanceWithFederationState } from "./types/InstanceWithFederationState";
@@ -286,6 +289,7 @@ export { TransferCommunity } from "./types/TransferCommunity";
 export { UpdateTagline } from "./types/UpdateTagline";
 export { UpdateTotp } from "./types/UpdateTotp";
 export { UpdateTotpResponse } from "./types/UpdateTotpResponse";
+export { UploadImageResponse } from "./types/UploadImageResponse";
 export { UserBlockInstanceParams } from "./types/UserBlockInstanceParams";
 export { VerifyEmail } from "./types/VerifyEmail";
 export { VoteView } from "./types/VoteView";

package/dist/other_types.d.ts

@@ -2,20 +2,3 @@ export declare const VERSION = "v4";
 export interface UploadImage {
     image: File | Buffer;
 }
-export interface UploadImageResponse {
-    /**
-     * Is "ok" if the upload was successful; is something else otherwise.
-     */
-    msg: string;
-    files?: ImageFile[];
-    url?: string;
-    delete_url?: string;
-}
-export interface ImageFile {
-    file: string;
-    delete_token: string;
-}
-export interface DeleteImage {
-    token: string;
-    filename: string;
-}

package/dist/types/AuthenticateWithOauth.d.ts

@@ -4,6 +4,7 @@ import type { OAuthProviderId } from "./OAuthProviderId";
  */
 export type AuthenticateWithOauth = {
     code: string;
+    pkce_code_verifier?: string;
     oauth_provider_id: OAuthProviderId;
     redirect_uri: string;
     show_nsfw?: boolean;

package/dist/types/CommentAggregates.d.ts

@@ -12,4 +12,6 @@ export type CommentAggregates = {
      * The total number of children in this comment branch.
      */
     child_count: number;
+    report_count: number;
+    unresolved_report_count: number;
 };

package/dist/types/CreateOAuthProvider.d.ts

@@ -13,5 +13,6 @@ export type CreateOAuthProvider = {
     scopes: string;
     auto_verify_email?: boolean;
     account_linking_enabled?: boolean;
+    use_pkce?: boolean;
     enabled?: boolean;
 };

package/dist/types/DeleteImageParams.d.ts

@@ -0,0 +1,4 @@
+export type DeleteImageParams = {
+    file: string;
+    token: string;
+};

package/dist/types/DeleteImageParams.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/EditOAuthProvider.d.ts

@@ -13,5 +13,6 @@ export type EditOAuthProvider = {
     scopes?: string;
     auto_verify_email?: boolean;
     account_linking_enabled?: boolean;
+    use_pkce?: boolean;
     enabled?: boolean;
 };

package/dist/types/ImageGetParams.d.ts

@@ -0,0 +1,4 @@
+export type ImageGetParams = {
+    format: string | null;
+    thumbnail: number | null;
+};

package/dist/types/ImageGetParams.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/ImageProxyParams.d.ts

@@ -0,0 +1,5 @@
+export type ImageProxyParams = {
+    url: string;
+    format: string | null;
+    thumbnail: number | null;
+};

package/dist/types/ImageProxyParams.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/LemmyErrorType.d.ts

@@ -41,6 +41,8 @@ export type LemmyErrorType = {
     error: "no_content_type_header";
 } | {
     error: "not_an_image_type";
+} | {
+    error: "invalid_image_upload";
 } | {
     error: "not_a_mod_or_admin";
 } | {
@@ -130,6 +132,8 @@ export type LemmyErrorType = {
     error: "rate_limit_error";
 } | {
     error: "invalid_name";
+} | {
+    error: "invalid_code_verifier";
 } | {
     error: "invalid_display_name";
 } | {

package/dist/types/OAuthProvider.d.ts

@@ -56,4 +56,8 @@ export type OAuthProvider = {
     enabled: boolean;
     published: string;
     updated?: string;
+    /**
+     * switch to enable or disable PKCE
+     */
+    use_pkce: boolean;
 };

package/dist/types/PostAggregates.d.ts

@@ -13,4 +13,6 @@ export type PostAggregates = {
      * The time of the newest comment in the post.
      */
     newest_comment_time: string;
+    report_count: number;
+    unresolved_report_count: number;
 };

package/dist/types/SaveUserSettings.d.ts

@@ -40,10 +40,6 @@ export type SaveUserSettings = {
      * The language of the lemmy interface
      */
     interface_language?: string;
-    /**
-     * A URL for your avatar.
-     */
-    avatar?: string;
     /**
      * A URL for your banner.
      */

package/dist/types/UploadImageResponse.d.ts

@@ -0,0 +1,5 @@
+export type UploadImageResponse = {
+    image_url: string;
+    filename: string;
+    delete_token: string;
+};

package/dist/types/UploadImageResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "0.20.0-api-v4.16",
+  "version": "0.20.0-image-api-rework.0",
   "author": "Dessalines <tyhou13@gmx.com>",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -31,11 +31,11 @@
     "prettier-plugin-organize-imports": "^4.0.0",
     "prettier-plugin-packagejson": "^2.5.1",
     "sortpack": "^2.4.0",
-    "typedoc": "^0.26.5",
+    "typedoc": "^0.27.0",
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.7.0"
   },
-  "packageManager": "pnpm@9.14.2",
+  "packageManager": "pnpm@9.15.0",
   "types": "./dist/index.d.ts",
   "lint-staged": {
     "*.{ts,tsx,js}": [