lemmy-js-client 0.17.0-rc.60 → 0.17.0-rc.62

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +22 -3
  2. package/dist/interfaces/api/site.d.ts +3 -5
  3. package/dist/interfaces/source.d.ts +1 -1
  4. package/dist/interfaces/source.js +1 -1
  5. package/package.json +1 -1
package/README.md CHANGED
@@ -4,6 +4,7 @@
4
4
  [![GitHub issues](https://img.shields.io/github/issues-raw/LemmyNet/lemmy-js-client.svg)](https://github.com/LemmyNet/lemmy-js-client/issues)
5
5
  [![License](https://img.shields.io/github/license/LemmyNet/lemmy-js-client.svg)](LICENSE)
6
6
  ![GitHub stars](https://img.shields.io/github/stars/LemmyNet/lemmy-js-client?style=social)
7
+
7
8
  </div>
8
9
 
9
10
  # lemmy-js-client
@@ -21,14 +22,14 @@ A javascript / typescript http and websocket client and type system for [Lemmy](
21
22
  [LemmyWebsocket docs](https://join-lemmy.org/api/classes/LemmyWebsocket.html)
22
23
 
23
24
  ```ts
24
- import { Login, LemmyWebsocket } from 'lemmy-js-client';
25
+ import { Login, LemmyWebsocket } from "lemmy-js-client";
25
26
 
26
27
  let client: LemmyWebsocket = new LemmyWebsocket();
27
28
 
28
- let form = new Login({
29
+ let form: Login = {
29
30
  username_or_email: "my_email@email.tld",
30
31
  password: "my_pass",
31
- });
32
+ };
32
33
 
33
34
  this.ws.send(client.login(form));
34
35
  ```
@@ -44,3 +45,21 @@ let baseUrl = 'https://lemmy.ml';
44
45
  let client: LemmyHttp = new LemmyHttp(baseUrl, headers?);
45
46
  let jwt = await client.httpLogin(loginForm).jwt;
46
47
  ```
48
+
49
+ ## Development
50
+
51
+ You can use [yalc](https://github.com/wclr/yalc) to develop and test changes locally:
52
+
53
+ ```
54
+ yarn global add yalc
55
+
56
+ # Go to lemmy-js-client dir
57
+ yalc publish --push
58
+
59
+ # Go to your client dir
60
+ yalc add lemmy-js-client
61
+
62
+ # To do updates, go back to the lemmy-js-client dir
63
+ # This also updates it, in every dir you've added it.
64
+ yalc publish --push
65
+ ```
package/dist/interfaces/api/site.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { ListingType, ModlogActionType, SearchType, SortType } from "../others";
2
- import { Language, Tagline } from "../source";
2
+ import { Language, RegistrationMode, Tagline } from "../source";
3
3
  import { AdminPurgeCommentView, AdminPurgeCommunityView, AdminPurgePersonView, AdminPurgePostView, CommentView, CommunityBlockView, CommunityFollowerView, CommunityModeratorView, CommunityView, LocalUserSettingsView, ModAddCommunityView, ModAddView, ModBanFromCommunityView, ModBanView, ModFeaturePostView, ModLockPostView, ModRemoveCommentView, ModRemoveCommunityView, ModRemovePostView, ModTransferCommunityView, PersonBlockView, PersonViewSafe, PostView, RegistrationApplicationView, SiteView } from "../views";
4
4
  /**
5
5
  * Search lemmy for different types of data.
@@ -61,11 +61,10 @@ export interface CreateSite {
61
61
  icon?: string;
62
62
  banner?: string;
63
63
  enable_downvotes?: boolean;
64
- open_registration?: boolean;
65
64
  enable_nsfw?: boolean;
66
65
  community_creation_admin_only?: boolean;
67
66
  require_email_verification?: boolean;
68
- require_application?: boolean;
67
+ registration_mode?: RegistrationMode;
69
68
  application_question?: string;
70
69
  private_instance?: boolean;
71
70
  default_theme?: string;
@@ -105,11 +104,10 @@ export interface EditSite {
105
104
  icon?: string;
106
105
  banner?: string;
107
106
  enable_downvotes?: boolean;
108
- open_registration?: boolean;
109
107
  enable_nsfw?: boolean;
110
108
  community_creation_admin_only?: boolean;
111
109
  require_email_verification?: boolean;
112
- require_application?: boolean;
110
+ registration_mode?: RegistrationMode;
113
111
  application_question?: string;
114
112
  private_instance?: boolean;
115
113
  default_theme?: string;
package/dist/interfaces/source.d.ts CHANGED
@@ -56,7 +56,7 @@ export interface Site {
56
56
  }
57
57
  export declare enum RegistrationMode {
58
58
  Closed = "closed",
59
- RequireApplication = "require_application",
59
+ RequireApplication = "requireapplication",
60
60
  Open = "open"
61
61
  }
62
62
  export interface LocalSite {
package/dist/interfaces/source.js CHANGED
@@ -4,6 +4,6 @@ exports.RegistrationMode = void 0;
4
4
  var RegistrationMode;
5
5
  (function (RegistrationMode) {
6
6
  RegistrationMode["Closed"] = "closed";
7
- RegistrationMode["RequireApplication"] = "require_application";
7
+ RegistrationMode["RequireApplication"] = "requireapplication";
8
8
  RegistrationMode["Open"] = "open";
9
9
  })(RegistrationMode = exports.RegistrationMode || (exports.RegistrationMode = {}));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "lemmy-js-client",
3
- "version": "0.17.0-rc.60",
3
+ "version": "0.17.0-rc.62",
4
4
  "description": "A javascript / typescript client for Lemmy",
5
5
  "repository": "https://github.com/LemmyNet/lemmy-js-client",
6
6
  "license": "AGPL-3.0",