diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 0aded1c..9a0b044 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -20,9 +20,9 @@ jobs: yarn install - name: Build run: | - yarn run build + yarn workspace megalodon run build - name: Publish run: | - yarn publish + yarn workspace megalodon publish env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 6dd21ca..ab47564 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -28,19 +28,13 @@ jobs: yarn install - name: Build run: | - yarn run build + yarn workspace megalodon run build - name: Testing run: | - yarn run test + yarn workspace megalodon run test - name: Browser example - working-directory: example/browser run: | - rm -rf node_modules - npm install - npm run build - - name: Browser typescript - working-directory: example/typescript + yarn workspace browser run build + - name: Typescript example run: | - rm -rf node_modules - npm install - npm run build + yarn workspace example run build diff --git a/.npmignore b/.npmignore deleted file mode 100644 index 850c6da..0000000 --- a/.npmignore +++ /dev/null @@ -1,11 +0,0 @@ -node_modules -./src -./example -*.log -.eslintrc.js -.gitignore -.prettierrc -.travis.yml -sideci.yml -tsconfig.json -tslint.json diff --git a/docs/classes/Mastodon.html b/docs/classes/Mastodon.html index 0c95416..9006ddd 100644 --- a/docs/classes/Mastodon.html +++ b/docs/classes/Mastodon.html @@ -1,4 +1,4 @@ -
- Preparing search index...
- The search index is not available
megalodonClass Mastodon
Hierarchy
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
baseUrl: string
hostname or base URL
accessToken: null | string = null
access token from OAuth2 authorization
@@ -6,72 +6,72 @@UserAgent is specified in header on request.
proxyConfig: false | ProxyConfig = false
Proxy setting, or set false if don't use proxy.
-Returns Mastodon
Properties
base Url
client
Methods
accept Follow Request
Returns Mastodon
Properties
base Url
client
Methods
accept Follow Request
POST /api/v1/follow_requests/:id/authorize
Parameters
id: string
Returns Promise<Response<Relationship>>
Relationship.
-add Accounts To List
add Accounts To List
POST /api/v1/lists/:id/accounts
-Parameters
id: string
account_ids: string[]
Returns Promise<Response<{}>>
block Account
Parameters
id: string
account_ids: string[]
Returns Promise<Response<{}>>
block Account
POST /api/v1/accounts/:id/block
Parameters
id: string
Returns Promise<Response<Relationship>>
Relationship
-block Domain
block Domain
POST/api/v1/domain_blocks
-Parameters
domain: string
Returns Promise<Response<{}>>
bookmark Status
Parameters
domain: string
Returns Promise<Response<{}>>
bookmark Status
POST /api/v1/statuses/:id/bookmark
Parameters
id: string
Returns Promise<Response<Entity.Status>>
Status.
-cancel
cancel
Cancel all requests in this instance.
Returns void
void
-cancel Scheduled Status
cancel Scheduled Status
DELETE /api/v1/scheduled_statuses/:id
-Parameters
id: string
Returns Promise<Response<{}>>
create App
Parameters
id: string
Returns Promise<Response<{}>>
create App
Call /api/v1/apps
Create an application.
Parameters
client_name: string
your application's name
options: Partial<{ redirect_uris: string; scopes: string[]; website: string }>
Form Data
-Returns Promise<AppData>
create Emoji Reaction
Parameters
_id: string
_emoji: string
Returns Promise<Response<Entity.Status>>
create Featured Tag
Returns Promise<AppData>
create Emoji Reaction
Parameters
_id: string
_emoji: string
Returns Promise<Response<Entity.Status>>
create Featured Tag
POST /api/v1/featured_tags
Parameters
name: string
Returns Promise<Response<FeaturedTag>>
FeaturedTag.
-create Filter
create Filter
POST /api/v1/filters
Parameters
phrase: string
context: string[]
Optional options: { expires_in?: string; irreversible?: boolean; whole_word?: boolean }
Optional expires_ in?: string
Optional irreversible?: boolean
Optional whole_ word?: boolean
Returns Promise<Response<Filter>>
Filter
-create List
create List
POST /api/v1/lists
Parameters
title: string
Returns Promise<Response<List>>
List.
-delete Accounts From List
delete Accounts From List
DELETE /api/v1/lists/:id/accounts
-Parameters
id: string
account_ids: string[]
Returns Promise<Response<{}>>
delete Conversation
Parameters
id: string
account_ids: string[]
Returns Promise<Response<{}>>
delete Conversation
DELETE /api/v1/conversations/:id
-Parameters
id: string
Returns Promise<Response<{}>>
delete Emoji Reaction
Parameters
_id: string
_emoji: string
Returns Promise<Response<Entity.Status>>
delete Featured Tag
Parameters
id: string
Returns Promise<Response<{}>>
delete Emoji Reaction
Parameters
_id: string
_emoji: string
Returns Promise<Response<Entity.Status>>
delete Featured Tag
DELETE /api/v1/featured_tags/:id
Parameters
id: string
Returns Promise<Response<{}>>
Empty
-delete Filter
delete Filter
DELETE /api/v1/filters/:id
Parameters
id: string
Returns Promise<Response<Filter>>
Removed filter.
-delete List
delete List
DELETE /api/v1/lists/:id
-Parameters
id: string
Returns Promise<Response<{}>>
delete Push Subscription
Parameters
id: string
Returns Promise<Response<{}>>
delete Push Subscription
DELETE /api/v1/push/subscription
-Returns Promise<Response<{}>>
delete Status
Returns Promise<Response<{}>>
delete Status
DELETE /api/v1/statuses/:id
Parameters
id: string
Returns Promise<Response<Entity.Status>>
Status
-direct Socket
Returns default
direct Stream
Returns StreamListenerInterface
dismiss Notification
direct Socket
Returns default
direct Stream
Returns StreamListenerInterface
dismiss Notification
POST /api/v1/notifications/:id/dismiss
-Parameters
id: string
Returns Promise<Response<{}>>
dismiss Notifications
Parameters
id: string
Returns Promise<Response<{}>>
dismiss Notifications
POST /api/v1/notifications/clear
-Returns Promise<Response<{}>>
favourite Status
Returns Promise<Response<{}>>
favourite Status
POST /api/v1/statuses/:id/favourite
Parameters
id: string
Returns Promise<Response<Entity.Status>>
Status.
-fetch Access Token
fetch Access Token
POST /oauth/token
Fetch OAuth access token. Get an access token based client_id and client_secret and authorization code.
-Parameters
client_id: null | string
client_secret: string
code: string
redirect_uri: string = NO_REDIRECT
Returns Promise<TokenData>
follow Account
Parameters
client_id: null | string
client_secret: string
code: string
redirect_uri: string = NO_REDIRECT
Returns Promise<TokenData>
follow Account
POST /api/v1/accounts/:id/follow
Parameters
id: string
Optional options: { reblog?: boolean }
Optional reblog?: boolean
Returns Promise<Response<Relationship>>
Relationship
-generate Auth Url
generate Auth Url
Generate authorization url using OAuth2.
Parameters
clientId: string
your OAuth app's client ID
@@ -79,267 +79,267 @@ Get an access token based client_id and client_secret and authorization code.your OAuth app's client Secretoptions: Partial<{ redirect_uri: string; scope: string[] }>
as property, redirect_uri and scope are available, and must be the same as when you register your app
-Returns Promise<string>
get Account
Returns Promise<string>
get Account
GET /api/v1/accounts/:id
Parameters
id: string
Returns Promise<Response<Entity.Account>>
An account.
-get Account Favourites
get Account Favourites
GET /api/v1/pleroma/accounts/:id/favourites
Parameters
_id: string
Optional _options: { limit?: number; max_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional since_ id?: string
Returns Promise<Response<Entity.Status[]>>
Array of statuses.
-get Account Followers
get Account Followers
GET /api/v1/accounts/:id/followers
Parameters
id: string
Optional options: { limit?: number; max_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional since_ id?: string
Returns Promise<Response<Entity.Account[]>>
The array of accounts.
-get Account Following
get Account Following
GET /api/v1/accounts/:id/following
Parameters
id: string
Optional options: { limit?: number; max_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional since_ id?: string
Returns Promise<Response<Entity.Account[]>>
The array of accounts.
-get Account Lists
get Account Lists
GET /api/v1/accounts/:id/lists
Parameters
id: string
Returns Promise<Response<List[]>>
The array of lists.
-get Account Statuses
get Account Statuses
GET /api/v1/accounts/:id/statuses
Parameters
id: string
Optional options: { exclude_reblogs?: boolean; exclude_replies?: boolean; limit?: number; max_id?: string; only_media: boolean; pinned?: boolean; since_id?: string }
Optional exclude_ reblogs?: boolean
Optional exclude_ replies?: boolean
Optional limit?: number
Optional max_ id?: string
only_ media: boolean
Optional pinned?: boolean
Optional since_ id?: string
Returns Promise<Response<Entity.Status[]>>
Account's statuses.
-get Accounts In List
get Accounts In List
GET /api/v1/lists/:id/accounts
Parameters
id: string
Optional options: { limit?: number; max_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional since_ id?: string
Returns Promise<Response<Entity.Account[]>>
Array of accounts.
-get Blocks
get Blocks
GET /api/v1/blocks
Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Returns Promise<Response<Entity.Account[]>>
Array of accounts.
-get Bookmarks
get Bookmarks
GET /api/v1/bookmarks
Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Optional since_ id?: string
Returns Promise<Response<Entity.Status[]>>
Array of statuses.
-get Conversation Timeline
get Conversation Timeline
GET /api/v1/conversations
Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Optional since_ id?: string
Returns Promise<Response<Conversation[]>>
Array of statuses.
-get Domain Blocks
get Domain Blocks
GET /api/v1/domain_blocks
Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Returns Promise<Response<string[]>>
Array of domain name.
-get Emoji Reaction
Parameters
_id: string
_emoji: string
Returns Promise<Response<Reaction>>
get Emoji Reactions
Parameters
_id: string
Returns Promise<Response<Reaction[]>>
get Endorsements
get Emoji Reaction
Parameters
_id: string
_emoji: string
Returns Promise<Response<Reaction>>
get Emoji Reactions
Parameters
_id: string
Returns Promise<Response<Reaction[]>>
get Endorsements
GET /api/v1/endorsements
Parameters
Optional options: { limit?: number; max_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional since_ id?: string
Returns Promise<Response<Entity.Account[]>>
Array of accounts.
-get Favourites
get Favourites
GET /api/v1/favourites
Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Returns Promise<Response<Entity.Status[]>>
Array of statuses.
-get Featured Tags
get Featured Tags
GET /api/v1/featured_tags
Returns Promise<Response<FeaturedTag[]>>
Array of featured tag.
-get Filter
get Filter
GET /api/v1/filters/:id
Parameters
id: string
Returns Promise<Response<Filter>>
Filter.
-get Filters
get Filters
GET /api/v1/filters
Returns Promise<Response<Filter[]>>
Array of filters.
-get Follow Requests
get Follow Requests
GET /api/v1/follow_requests
Parameters
Optional limit: number
Returns Promise<Response<Entity.Account[]>>
Array of account.
-get Home Timeline
get Home Timeline
GET /api/v1/timelines/home
Parameters
Optional options: { limit?: number; local?: boolean; max_id?: string; min_id?: string; since_id?: string }
Optional limit?: number
Optional local?: boolean
Optional max_ id?: string
Optional min_ id?: string
Optional since_ id?: string
Returns Promise<Response<Entity.Status[]>>
Array of statuses.
-get Identity Proof
get Identity Proof
GET /api/v1/accounts/:id/identity_proofs
Parameters
id: string
Returns Promise<Response<IdentityProof[]>>
Array of IdentityProof
-get Instance
get Instance
GET /api/v1/instance
-Returns Promise<Response<Instance>>
get Instance Activity
Returns Promise<Response<Instance>>
get Instance Activity
GET /api/v1/instance/activity
-Returns Promise<Response<Activity[]>>
get Instance Custom Emojis
Returns Promise<Response<Activity[]>>
get Instance Custom Emojis
GET /api/v1/custom_emojis
Returns Promise<Response<Emoji[]>>
Array of emojis.
-get Instance Directory
get Instance Directory
GET /api/v1/directory
Parameters
Optional options: { limit?: number; local?: boolean; offset?: number; order?: "active" | "new" }
Optional limit?: number
Optional local?: boolean
Optional offset?: number
Optional order?: "active" | "new"
Returns Promise<Response<Entity.Account[]>>
Array of accounts.
-get Instance Peers
get Instance Peers
GET /api/v1/instance/peers
-Returns Promise<Response<string[]>>
get Instance Trends
Returns Promise<Response<string[]>>
get Instance Trends
GET /api/v1/trends
Parameters
Optional limit: null | number
Maximum number of results to return. Defaults to 10.
-Returns Promise<Response<Tag[]>>
get List
Returns Promise<Response<Tag[]>>
get List
GET /api/v1/lists/:id
Parameters
id: string
Returns Promise<Response<List>>
List.
-get List Timeline
get List Timeline
GET /api/v1/timelines/list/:list_id
Parameters
list_id: string
Optional options: { limit?: number; max_id?: string; min_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Optional since_ id?: string
Returns Promise<Response<Entity.Status[]>>
Array of statuses.
-get Lists
get Lists
GET /api/v1/lists
Returns Promise<Response<List[]>>
Array of lists.
-get Local Timeline
get Local Timeline
GET /api/v1/timelines/public
Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string; only_media?: boolean; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Optional only_ media?: boolean
Optional since_ id?: string
Returns Promise<Response<Entity.Status[]>>
Array of statuses.
-get Markers
get Markers
GET /api/v1/markers
Parameters
timeline: string[]
Returns Promise<Response<{} | Marker>>
Marker or empty object.
-get Mutes
get Mutes
GET /api/v1/mutes
Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Returns Promise<Response<Entity.Account[]>>
Array of accounts.
-get Notification
get Notification
GET /api/v1/notifications/:id
Parameters
id: string
Returns Promise<Response<Notification>>
Notification.
-get Notifications
get Notifications
GET /api/v1/notifications
Parameters
Optional options: { account_id?: string; exclude_types?: string[]; limit?: number; max_id?: string; min_id?: string; since_id?: string }
Optional account_ id?: string
Optional exclude_ types?: string[]
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Optional since_ id?: string
Returns Promise<Response<Notification[]>>
Array of notifications.
-get Poll
get Poll
GET /api/v1/polls/:id
Parameters
id: string
Returns Promise<Response<Poll>>
Poll
-get Preferences
get Preferences
GET /api/v1/preferences
Returns Promise<Response<Preferences>>
Preferences.
-get Public Timeline
get Public Timeline
GET /api/v1/timelines/public
Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string; only_media?: boolean; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Optional only_ media?: boolean
Optional since_ id?: string
Returns Promise<Response<Entity.Status[]>>
Array of statuses.
-get Push Subscription
get Push Subscription
GET /api/v1/push/subscription
Returns Promise<Response<PushSubscription>>
PushSubscription.
-get Relationship
get Relationship
GET /api/v1/accounts/relationships
Parameters
id: string
Returns Promise<Response<Relationship>>
Relationship
-get Relationships
get Relationships
Get multiple relationships in one method
Parameters
ids: string[]
Returns Promise<Response<Relationship[]>>
Array of Relationship.
-get Scheduled Status
get Scheduled Status
GET /api/v1/scheduled_statuses/:id
Parameters
id: string
Returns Promise<Response<ScheduledStatus>>
ScheduledStatus.
-get Scheduled Statuses
get Scheduled Statuses
GET /api/v1/scheduled_statuses
Parameters
Optional options: { limit?: null | number; max_id?: null | string; min_id?: null | string; since_id?: null | string }
Optional limit?: null | number
Optional max_ id?: null | string
Optional min_ id?: null | string
Optional since_ id?: null | string
Returns Promise<Response<ScheduledStatus[]>>
Array of scheduled statuses.
-get Status
get Status
GET /api/v1/statuses/:id
Parameters
id: string
Returns Promise<Response<Entity.Status>>
Status
-get Status Context
get Status Context
GET /api/v1/statuses/:id/context
Get parent and child statuses.
Parameters
id: string
Optional options: { limit?: number; max_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional since_ id?: string
Returns Promise<Response<Context>>
Context
-get Status Favourited By
get Status Favourited By
GET /api/v1/statuses/:id/favourited_by
Parameters
id: string
Returns Promise<Response<Entity.Account[]>>
Array of accounts.
-get Status Reblogged By
get Status Reblogged By
GET /api/v1/statuses/:id/reblogged_by
Parameters
id: string
Returns Promise<Response<Entity.Account[]>>
Array of accounts.
-get Suggested Tags
get Suggested Tags
GET /api/v1/featured_tags/suggestions
Returns Promise<Response<Tag[]>>
Array of tag.
-get Suggestions
get Suggestions
GET /api/v1/suggestions
Parameters
Optional limit: number
Returns Promise<Response<Entity.Account[]>>
Array of accounts.
-get Tag Timeline
get Tag Timeline
GET /api/v1/timelines/tag/:hashtag
Parameters
hashtag: string
Optional options: { limit?: number; local?: boolean; max_id?: string; min_id?: string; only_media?: boolean; since_id?: string }
Optional limit?: number
Optional local?: boolean
Optional max_ id?: string
Optional min_ id?: string
Optional only_ media?: boolean
Optional since_ id?: string
Returns Promise<Response<Entity.Status[]>>
Array of statuses.
-list Socket
Parameters
list_id: string
Returns default
list Stream
Parameters
list_id: string
Returns StreamListenerInterface
local Socket
Returns default
local Stream
Returns StreamListenerInterface
mute Account
list Socket
Parameters
list_id: string
Returns default
list Stream
Parameters
list_id: string
Returns StreamListenerInterface
local Socket
Returns default
local Stream
Returns StreamListenerInterface
mute Account
POST /api/v1/accounts/:id/mute
Parameters
id: string
notifications: boolean = true
Returns Promise<Response<Relationship>>
Relationship
-mute Status
mute Status
POST /api/v1/statuses/:id/mute
Parameters
id: string
Returns Promise<Response<Entity.Status>>
Status
-pin Account
pin Account
POST /api/v1/accounts/:id/pin
Parameters
id: string
Returns Promise<Response<Relationship>>
Relationship
-pin Status
pin Status