Using a TokenAuth should request a `refresh_token` grant. Using a UsernameAuth should request a `password` grant, and using no auth should request a client_credentials grant. This is currently pending nock/nock#2171.

This issue was generated by todo based on a TODO comment in 7391759. It's been assigned to @thislooksfun because they committed the code.

This issue was generated by todo based on a TODO comment in bd0fc8b. It's been assigned to @thislooksfun because they committed the code.

Fetching a suspended user gives back very minimal data, meaning that this typing below is only a valid base for non-suspended users. I'm not sure what the best way to deal with this is...

This issue was generated by todo based on a TODO comment in bd0fc8b. It's been assigned to @thislooksfun because they committed the code.

This issue was generated by todo based on a TODO comment in bd0fc8b. It's been assigned to @thislooksfun because they committed the code.

Pending nock/nock#2171.

This issue was generated by todo based on a TODO comment in 98c5e3c. It's been assigned to @thislooksfun because they committed the code.

GitHub actions now have a concurrency feature, which is what we were using styfle/cancel-workflow-action to try to replicate. We should switch to the native syntax instead.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• chore(deps): update all non-major dev dependencies (@commitlint/cli, @commitlint/config-conventional, @semantic-release/github, @semantic-release/npm, @semantic-release/release-notes-generator, @types/debug, @types/jest, @typescript-eslint/eslint-plugin, @typescript-eslint/parser, eslint, fast-check, semantic-release, typedoc, typescript)
• chore(deps): update semantic-release monorepo (major) (@semantic-release/commit-analyzer, @semantic-release/github)

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• fix(deps): update dependency tslib to ^2.5.3
• chore(deps): update dependency eslint-plugin-comment-length to v1
• fix(deps): update dependency camelcase to v7
• fix(deps): update dependency got to v13

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

There are still several large areas of the codebase that need work before snoots has feature-parity with snoowrap. For a full class-by-class rundown of what is missing see below. If you have a specific needs that snoots doesn't currently meet, please let me know so I can prioritize accordingly!

Snoowrap Classes:

Notes/caveats:

• This is comparing [email protected] against [email protected].
• The names used here are snoowrap's names. snoots' naming scheme is often different.
• I tried to be as complete as possible but it's likely I missed something.
• This does not cover any method parameters, just the methods themselves.
• This is a live list, it will be updated as compatibility improves.

snoowrap

• Missing properties
  • accessToken¹
  • clientId¹
  • clientSecret¹
  • password¹
  • tokenExpiration²
  • userAgent¹
  • username¹
• Missing methods
  • bulkReadNewModmail()
  • checkCaptchaRequirement()
  • composeMessage()³
  • createLivethread()
  • createModmailDiscussion()
  • createMultireddit()
  • createSubreddit()
  • credentialedClientRequest()¹
  • getBest()
  • getBlockedUsers()
  • getCaptchaImage()
  • getContentByIds()²
  • getFriends()
  • getInbox()³
  • getKarma()
  • getLivethread()
  • getMessage()³
  • getModmail()¹
  • getMyMultireddits()
  • getMyTrophies()
  • getNewCaptchaIdentifier()
  • getNewModmailConversation()
  • getNewModmailConversations()
  • getNewModmailSubreddits()
  • getOauthScopeList()
  • getPreferences()
  • getSavedCategories()
  • getSentMessages()³
  • getStickiedLivethread()
  • getUnreadMessages()³
  • getUnreadNewModmailConversationsCount()
  • markAsVisited()
  • markMessagesAsRead()³
  • markMessagesAsUnread()³
  • markNewModmailConversationsAsRead()
  • markNewModmailConversationsAsUnread()
  • noConflict()²
  • oauthRequest()¹
  • rawRequest()¹
  • readAllMessages()³
  • revokeAccessToken()
  • revokeRefreshToken()
  • searchSubredditNames()
  • searchSubreddits()
  • searchSubredditTopics()
  • unauthenticatedRequest()¹
  • updatePreferences()

RedditContent (base class for all items)

• Missing properties
  • created¹
• Missing methods
  • fetch()¹
  • refresh()¹
  • toJSON()¹

ReplyableContent (extends RedditContent)

✅ Full feature parity.

VoteableContent (extends ReplyableContent)

• Missing properties
  • author_flair_background_color
  • author_flair_css_class
  • author_flair_richtext
  • author_flair_template_id
  • author_flair_text_color
  • author_flair_text
  • author_flair_type
  • author_fullname¹
  • downs¹
  • no_follow
  • removal_reason
  • report_reasons
  • subreddit_id¹
  • subreddit_name_prefixed¹
  • ups¹

Comment (extends VoteableContent)

• Missing properties
  • collapsed_reason
  • controversiality
  • depth
• Missing methods
  • expandReplies()¹

RedditUser (extends RedditContent)

• Properties
  • features
  • gold_creddits
  • modhash²
  • new_modmail_exists¹
  • oauth_client_id²
  • pref_clickgadget²
  • pref_geopopular²
  • pref_show_snoovatar²
  • pref_top_karma_subreddits²
• Methods
  • assignFlair()
  • friend()
  • getDownvotedContent()
  • getFriendInformation()
  • getGildedContent()
  • getHiddenContent()
  • getMultireddit()
  • getMultireddits()
  • getOverview()
  • getSavedContent()
  • getTrophies()
  • getUpvotedContent()
  • giveGold()
  • unfriend()

Submission (extends VoteableContent)

• Missing properties
  • clicked
  • content_categories
  • link_flair_background_color
  • link_flair_css_class
  • link_flair_richtext
  • link_flair_template_id
  • link_flair_text_color
  • link_flair_text
  • link_flair_type
  • media_embed
  • media_only
  • media
  • parent_whitelist_status
  • post_hint
  • preview
  • previous_visits
  • pwls²
  • quarantine
  • removal_reason
  • removed_by_category
  • secure_media_embed
  • secure_media
  • selftext_html
  • selftext
  • thumbnail
  • view_count
  • visited
  • whitelist_status
  • wls²
• Missing Methods
  • assignFlair()
  • getLinkFlairTemplates()
  • getRelated()¹
  • markAsRead()
  • selectFlair()

LiveThread (extends RedditContent)

❌ Unimplemented

PrivateMessage (extends ReplyableContent)

❌ Unimplemented

Subreddit (extends RedditContent)

• Missing properties
  • accounts_active
  • advertiser_category
  • allow_discovery
  • allow_images
  • allow_videogifs
  • allow_videos
  • has_menu_widget
  • icon_img
  • icon_size
  • is_enrolled_in_new_modmail¹
  • key_color
  • lang
  • link_flair_enabled
  • link_flair_position
  • notification_level
  • primary_color
  • public_description_html
  • public_description
  • suggested_comment_sort
  • user_can_flair_in_sr
  • user_flair_background_color
  • user_flair_css_class
  • user_flair_enabled_in_sr
  • user_flair_position
  • user_flair_richtext
  • user_flair_template_id
  • user_flair_text_color
  • user_flair_text
  • whitelist_status
  • wls
• Missing methods
  • configureFlair()
  • createLinkFlairTemplate()
  • createUserFlairTemplate()
  • deleteAllLinkFlairTemplates()
  • deleteAllUserFlairTemplates()
  • deleteBanner()
  • deleteFlairTemplate()
  • deleteHeader()
  • deleteIcon()
  • deleteImage()
  • deleteUserFlair()
  • editSettings()
  • getLinkFlairTemplates()
  • getModerationLog()
  • getModmail()
  • getMyFlair()
  • getNewModmailConversations()
  • getRecommendedSubreddits()
  • getRules()
  • getSettings()
  • getSticky()
  • getStylesheet()
  • getSubmitText()
  • getUserFlair()
  • getUserFlairList()
  • getUserFlairTemplates()
  • getWikiPage()
  • getWikiPages()
  • getWikiRevisions()
  • hideMyFlair()
  • inviteModerator()
  • leaveModerator()
  • removeModerator()
  • revokeModeratorInvite()
  • selectMyFlair()
  • setModeratorPermissions()
  • setMultipleUserFlairs()
  • showMyFlair()
  • subscribe()
  • unsubscribe()
  • updateStylesheet()
  • uploadBannerImage()
  • uploadHeaderImage()
  • uploadIcon()
  • uploadStylesheetImage()

MultiReddit (extends RedditContent)

❌ Unimplemented

ModmailConversation (extends RedditContent)

❌ Unimplemented

ModmailConversationAuthor (extends RedditContent)

❌ Unimplemented

WikiPage (extends RedditContent)

❌ Unimplemented

Listing

✅ Feature parity, but implemented very differently.

¹This will not be implemented.
²This is unlikely to be implemented.
³This relates to private messaging, which is an ongoing discussion.

Tracks progress towards #31.

To Reproduce
Post ID: nmftww

Expected behavior
A clear and concise description of what you expected to happen.

Describe the issue

I've been trying to get the comments for a post, rather unsuccessfully. I don't know if there is a bug or I'm doing something wrong (can post a gist or two if that's helpful). I've tried a number of different techniques and api calls, but with mixed success. I'm sure a working example is easy to hack together - would really appreciate it.

Feature Description

The Problem

I can't write jest tests without including secrets in the file itself, meaning I can't commit working tests

The Rationale

I'd like to start writing some tests for the features I've implemented (modnotes and wiki pages) and commit them to the repository, but I'm currently unable to do so as all my secrets are in the clear. By adding dotenv and dotenv-expand, a shared .env file could be added to the .gitignore file (updated as necessary for new tests). This will improve code coverage, and possibly allow test suites to be run on commit.

What happened?

Not sure if bug, or I'm using it wrong (sorry if so!). Pls advise on how to get comments for a post. I had assumed I could get the comments directly from a Post, but... The following blows up with the error "Unable to fetch next page" (see the Pager class in dist/reddit/listing/listing.js line 12):

import {Client} from "snoots";

const MyGateway = require("./MyGateway.js");

const name = "foo";
const clientId = "foo";
const version = "v0.1";
const clientSecret = "foo";

const userAgent = `typescript:${name}:${version}`;

...
    const subredditName = "MachineLearning";
    const subReddit = await client.subreddits.fetch(subredditName);

    const searchSyntax = "cloudsearch"// "cloudsearch" | "lucene" | "plain";
    const sort = "comments";// "relevance" | "hot" | "top" | "new" | "comments"
    const time = "year";// "hour" | "day" | "week" | "month" | "year" | "all"
    const posts = await subReddit.search("lstm", time, sort, searchSyntax);

    let i = 0;

    for await (const post of posts) {
        console.log(`${++i} ${post.id} ${post.title}: ${post.url}`);
        
        const isEmpty = await post.comments.empty();//          <---- this blows up
        if (isEmpty)
            continue;

        const comment = await post.comments.first();
        console.log(`\t${comment.body}`);
    }

Reproduction steps

1. Run the above (substituting the initial params)

Snoots Version

1.0.0-dev.22

Node Version

v16

Logs

1 t8fn7m [D] Are we at the end of an era where ML could be explained rigorously using mathematics?: https://www.reddit.com/r/MachineLearning/comments/t8fn7m/d_are_we_at_the_end_of_an_era_where_ml_could_be/
[UnhandledPromiseRejection: This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason "Unable to fetch next page".] {
  code: 'ERR_UNHANDLED_REJECTION'
}

Extra Information

No response

This issue was generated by todo based on a TODO comment in 6f7b81e. It's been assigned to @thislooksfun because they committed the code.

This change will add a nicer landing page at https://thislooks.fun/snoots and make the docs link (https://thislooks.fun/snoots/docs) more expressive.

This issue was generated by todo based on a TODO comment in bd0fc8b. It's been assigned to @thislooksfun because they committed the code.

This issue was generated by todo based on a TODO comment in 4a82ca4. It's been assigned to @thislooksfun because they committed the code.

The other commented sections need to be resolved at the same time as this in order to implement this properly. This is pending JamesIves/github-pages-deploy-action#635.

This issue was generated by todo based on a TODO comment in 154ee30. It's been assigned to @thislooksfun because they committed the code.

Feature Description

I'd like to locally cache some pages so that I'm not hammering reddit for the same data again and again, especially while testing.

I understand that GOT has hooks for providing your own. Could this be exposed in the options used to create the client?

https://github.com/sindresorhus/got/blob/HEAD/documentation/cache.md

Ideally, the cached requests would not count towards any in-built rate limiter (if there is one).

Hello,

In the documentation the link for step 3 is broken.
https://thislooks.fun/snoots/docs/latest/

Thanks

This issue was generated by todo based on a TODO comment in 6f7b81e. It's been assigned to @thislooksfun because they committed the code.

Feature Description

Moderator Notes

I feel like there should be a discussion on how/where modnotes are implemented, as a call to the API requires both a subreddit and a username. There are several questions then on how it should be implemented:

• Should Modnotes be implemented on a subreddit object or a user object, or both?
• Should modnotes have its own controller and defined on the client class?
• Should it take subreddits and users as strings (usernames) or as snoot objects? or both?

Typings

There are also issues on the typings of what is returned from the API calls themselves. I've put an example below:

type ModNoteTypeFilter = 'NOTE' | 'APPROVAL' | 'REMOVAL' | 'BAN' | 'MUTE' | 'INVITE' | 'SPAM' | 'CONTENT_CHANGE' | 'MOD_ACTION' | 'ALL' ;
export interface ModeratorNote {
  subreddit_id: string; // t5
  operator_id: string; // t2
  mod_action_data : {
    action: string;
    reddit_id: string;  // t1 or t3
    details: string;
    description: null // Not sure what the type is of this
  };
  subreddit: string;
  user: string;
  operator: string;
  id: string;
  user_note_data: {
    note: null;  // Not sure what the type is of this
    reddit_id: string; // t1 or t3
    label: null  // Not sure what the type is of this
  }
  user_id: string;  // t2
  created_at: number;
  cursor: string;
  type: ModNoteTypeFilter
}

I imagine ModeratorNote.user_note_data.label is defined as "(BOT_BAN, PERMA_BAN, BAN, ABUSE_WARNING, SPAM_WARNING, SPAM_WATCH, SOLID_CONTRIBUTOR, HELPFUL_USER)" by the API (optionally null).

Added features?

There is a good opportunity here to transform subreddit_ids, operator_ids and reddit_ids into their respective objects, or even to have a Modnote class with the appropriate methods for generating these objects.

API Endpoints

I'm listing these here just to make the discussion a touch easier

DELETE /api/mod/notes
Delete a mod user note where type=NOTE. Query params:

• note_id: a unique ID for the note to be deleted (should have a ModNote_ prefix)
• subreddit: subreddit name (not prefixed, from what I can tell)
• username account username (also not prefixed)

GET /api/mod/notes
Get mod notes for a specific user in a given subreddit. Query params:

• before: (optional) an encoded string used for pagination with mod notes
• filter: (optional) one of (NOTE, APPROVAL, REMOVAL, BAN, MUTE, INVITE, SPAM, CONTENT_CHANGE, MOD_ACTION, ALL), to be used for querying specific types of mod notes (default: all)
• limit: (optional) the number of mod notes to return in the response payload (default: 25, max: 100)'}
• subreddit: subreddit name (not prefixed, from what I can tell)
• username account username (also not prefixed)

POST /api/mod/notes
Create a mod user note where type=NOTE. Query params:

• label: (optional) one of (BOT_BAN, PERMA_BAN, BAN, ABUSE_WARNING, SPAM_WARNING, SPAM_WATCH, SOLID_CONTRIBUTOR, HELPFUL_USER)
• note: Content of the note, should be a string with a maximum character limit of 250
• reddit_id: (optional) a fullname of a comment or post (should have either a t1 or t3 prefix)
• subreddit: subreddit name (not prefixed, from what I can tell)
• username account username (also not prefixed)

GET /api/mod/notes/recent
Fetch the most recent notes written by a moderator

Both parameters should be comma separated lists of equal lengths. The first subreddit will be paired with the first account to represent a query for a mod written note for that account in that subreddit and so forth for all subsequent pairs of subreddits and accounts. This request accepts up to 500 pairs of subreddit names and usernames. Parameters should be passed as query parameters.

The response will be a list of mod notes in the order that subreddits and accounts were given. If no note exist for a given subreddit/account pair, then null will take its place in the list.

• subreddits: a comma delimited list of subreddits by name
• usernames account usernames

Thanks :)

This should be made to require the release job before v1.0.0. At that point we can likely also remove the 'if' clause here since that is accounted for by requiring 'release'.

This issue was generated by todo based on a TODO comment in efa4944. It's been assigned to @thislooksfun because they committed the code.

Currently both discussions are locked to collaborators only.

The commits I made you also didn't apply instead you copied them so they're both now attributed to you even though I wrote the changes.

This issue was generated by todo based on a TODO comment in bd0fc8b. It's been assigned to @thislooksfun because they committed the code.

Node 17.5.0 adds an implementation of fetch(). This is great as it will allow dropping got as a dependency, which will, in turn, allow for snoots to work in the browser (perhaps not out-of-the-gate, but still).

The catch is that the fetch() implementation is experimental and also currently only in the latest odd release. Once it becomes stable in an LTS release we should switch to it.

This issue was generated by todo based on a TODO comment in bd0fc8b. It's been assigned to @thislooksfun because they committed the code.

Discussed in #48

What happened?

export interface RedditListing {
  after?: string;
  before?: string;
  children: RedditObject[];
  dist?: number;
  modhash?: string;
}

RedditListing.children is defined as type RedditObject[], however, not all listings contain a field children of type RedditObject[]. This is most readily observed in the wiki revisions listing being worked on in #87, where children is an array of POD.

Reproduction steps

n/a

Snoots Version

all

Node Version

n/a

Logs

No response

Extra Information

No response

This issue was generated by todo based on a TODO comment in bd0fc8b. It's been assigned to @thislooksfun because they committed the code.

It runs fine on workflow_run, but not on branch push.

This issue was generated by todo based on a TODO comment in 29ab531. It's been assigned to @thislooksfun because they committed the code.

 const snoots = require('snoots');
    const client = new snoots.Client({
        userAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.80 Safari/537.36',
        creds: {
            clientId: 'Ox0zdas',
            clientSecret: 'ad0-asd',
        },

 
        auth:{
            username:'adsd',
            password:"adsd"
        }

    });

    const sub = await client.subreddits.fetch("funny");
    const post = await sub.getRandomPost();
    const title = post.title;

Error:

RequestError: connect ECONNREFUSED 127.0.0.1:443
    at ClientRequest.<anonymous> (/Users/dasdasd/Desktop/projects/asdasd/node_modules/snoots/node_modules/got/dist/source/core/index.js:962:111)
    at Object.onceWrapper (events.js:520:26)
    at ClientRequest.emit (events.js:412:35)
    at ClientRequest.emit (domain.js:475:12)
    at ClientRequest.origin.emit (/Users/dasdasd/Desktop/projects/asdasd/node_modules/snoots/node_modules/@szmarczak/http-timer/dist/source/index.js:43:20)
    at TLSSocket.socketErrorListener (_http_client.js:475:9)
    at TLSSocket.emit (events.js:400:28)
    at TLSSocket.emit (domain.js:475:12)
    at emitErrorNT (internal/streams/destroy.js:106:8)
    at emitErrorCloseNT (internal/streams/destroy.js:74:3)
    at processTicksAndRejections (internal/process/task_queues.js:82:21)
    at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1159:16) {
  code: 'ECONNREFUSED',
  timings: {
    start: 1644514843612,
    socket: 1644514843614,
    lookup: 1644514843614,
    connect: undefined,
    secureConnect: undefined,
    upload: undefined,
    response: undefined,
    end: undefined,
    error: 1644514843615,
    abort: undefined,
    phases: {
      wait: 2,
      dns: 0,
      tcp: undefined,
      tls: undefined,
      request: undefined,
      firstByte: undefined,
      download: undefined,
      total: 3
    }
  }

Node version:

v14.18.1

What happened?

When creating a Client with my Reddit app creds, it works from NodeJS REPL, but same code running inside firebase function gives 401.

It appears the app secret is not present in the password field of the request options.

Reproduction steps

Create a new Client(userAgent: “something”, creds:{clientId: “cid”, secretId: “ckey”});

Making Reddit API requests works correctly from Node REPL, but not from Firebase function. (Ran locally OR hosted)

Snoots Version

dev latest

Node Version

v16

Logs

401 from got pkg.

Extra Information

No response

This issue was generated by todo based on a TODO comment in 6f7b81e. It's been assigned to @thislooksfun because they committed the code.

Currently we just discard the auth scope(s), but some users rely on being able to query it. We should allow them to do so.

Currently there is only (incomplete) unit testing. This is great, as long as the Reddit API stays stable, which it won't. Unfortunately adding unit testing is non trivial since the endpoints are (rightly) rate-limited, which makes automated testing really annoying.

This issue was generated by todo based on a TODO comment in 2242494. It's been assigned to @thislooksfun because they committed the code.