diff --git a/src/claim.js b/src/claim.js index b757b2a..afca544 100644 --- a/src/claim.js +++ b/src/claim.js @@ -363,6 +363,7 @@ export class Claim { } /** + * @ignore * @param {object} claimObject - JSON representation of a claim * @returns {Claim | Error} Parsed claim */ @@ -404,6 +405,7 @@ function importJsonClaimVersion1 (claimObject) { } /** + * @ignore * @param {object} claimObject - JSON representation of a claim * @returns {Claim | Error} Parsed claim */ diff --git a/src/fetcher/activitypub.js b/src/fetcher/activitypub.js index 551a75e..d34f163 100644 --- a/src/fetcher/activitypub.js +++ b/src/fetcher/activitypub.js @@ -13,6 +13,14 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Fetch proofs using ActivityPub HTTP requests + * @module fetcher/activitypub + * @example + * import { fetcher } from 'doipjs'; + * const data = await fetcher.activitypub.fn({ url: 'https://domain.example/@alice' }); + */ + import axios from 'axios' import isURL from 'validator/lib/isURL.js' import { isNode } from 'browser-or-node' @@ -21,9 +29,10 @@ import { version } from '../constants.js' import * as Types from '../types.js' /** - * Timeout after which the fetch is aborted + * Default timeout after which the fetch is aborted * @constant * @type {number} + * @default 5000 */ export const timeout = 5000 diff --git a/src/fetcher/aspe.js b/src/fetcher/aspe.js index e425f5f..157c482 100644 --- a/src/fetcher/aspe.js +++ b/src/fetcher/aspe.js @@ -13,6 +13,13 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Fetch proofs from {@link module:profile~Profile} obtained through ASPE + * @module fetcher/aspe + * @example + * import { fetcher } from 'doipjs'; + * const data = await fetcher.aspe.fn({ aspeUri: 'aspe:domain.example:abc123def456' }); + */ import axios from 'axios' import isFQDN from 'validator/lib/isFQDN.js' import { version } from '../constants.js' @@ -20,9 +27,10 @@ import { parseProfileJws } from '../asp.js' import * as Types from '../types.js' /** - * Timeout after which the fetch is aborted + * Default timeout after which the fetch is aborted * @constant * @type {number} + * @default 5000 */ export const timeout = 5000 diff --git a/src/fetcher/dns.js b/src/fetcher/dns.js index 05ddd21..4f4c8b1 100644 --- a/src/fetcher/dns.js +++ b/src/fetcher/dns.js @@ -13,14 +13,23 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Fetch proofs using DNS TXT records + * @module fetcher/dns + * @example + * import { fetcher } from 'doipjs'; + * const data = await fetcher.dns.fn({ domain: 'domain.example' }); + */ + import { isBrowser } from 'browser-or-node' import dns from 'dns' import * as Types from '../types.js' /** - * Timeout after which the fetch is aborted + * Default timeout after which the fetch is aborted * @constant * @type {number} + * @default 5000 */ export const timeout = 5000 diff --git a/src/fetcher/graphql.js b/src/fetcher/graphql.js index c6458b3..09f7a31 100644 --- a/src/fetcher/graphql.js +++ b/src/fetcher/graphql.js @@ -13,14 +13,23 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Fetch proofs using GraphQL queries + * @module fetcher/graphql + * @example + * import { fetcher } from 'doipjs'; + * const data = await fetcher.graphql.fn({ url: 'https://domain.example/graphql/v2', query: '{ "query": "..." }' }); + */ + import axios from 'axios' import { version } from '../constants.js' import * as Types from '../types.js' /** - * Timeout after which the fetch is aborted + * Default timeout after which the fetch is aborted * @constant * @type {number} + * @default 5000 */ export const timeout = 5000 diff --git a/src/fetcher/http.js b/src/fetcher/http.js index 41fcc6c..f9f2ac3 100644 --- a/src/fetcher/http.js +++ b/src/fetcher/http.js @@ -13,15 +13,24 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Fetch proofs using HTTP requests + * @module fetcher/http + * @example + * import { fetcher } from 'doipjs'; + * const data = await fetcher.http.fn({ url: 'https://domain.example/data.json', format: 'json' }); + */ + import axios from 'axios' import { ProofFormat } from '../enums.js' import { version } from '../constants.js' import * as Types from '../types.js' /** - * Timeout after which the fetch is aborted + * Default timeout after which the fetch is aborted * @constant * @type {number} + * @default 5000 */ export const timeout = 5000 diff --git a/src/fetcher/irc.js b/src/fetcher/irc.js index 2dd061f..772b3b3 100644 --- a/src/fetcher/irc.js +++ b/src/fetcher/irc.js @@ -13,14 +13,23 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Fetch proofs using IRC + * @module fetcher/irc + * @example + * import { fetcher } from 'doipjs'; + * const data = await fetcher.irc.fn({ nick: 'alice', domain: 'domain.example' }); + */ + import irc from 'irc-upd' import isAscii from 'validator/lib/isAscii.js' import * as Types from '../types.js' /** - * Timeout after which the fetch is aborted + * Default timeout after which the fetch is aborted * @constant * @type {number} + * @default 20000 */ export const timeout = 20000 diff --git a/src/fetcher/matrix.js b/src/fetcher/matrix.js index a4fa6d8..25419fc 100644 --- a/src/fetcher/matrix.js +++ b/src/fetcher/matrix.js @@ -13,6 +13,14 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Fetch proofs using Matrix messages + * @module fetcher/matrix + * @example + * import { fetcher } from 'doipjs'; + * const data = await fetcher.matrix.fn({ eventId: '$abc123def456', roomId: '!dBfQZxCoGVmSTujfiv:matrix.org' }); + */ + import axios from 'axios' import isFQDN from 'validator/lib/isFQDN.js' import isAscii from 'validator/lib/isAscii.js' @@ -20,9 +28,10 @@ import { version } from '../constants.js' import * as Types from '../types.js' /** - * Timeout after which the fetch is aborted + * Default timeout after which the fetch is aborted * @constant * @type {number} + * @default 5000 */ export const timeout = 5000 diff --git a/src/fetcher/openpgp.js b/src/fetcher/openpgp.js index b828194..dbf15a8 100644 --- a/src/fetcher/openpgp.js +++ b/src/fetcher/openpgp.js @@ -13,6 +13,21 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Fetch proofs from OpenPGP notations + * @module fetcher/openpgp + * @example + * import { fetcher, enums as E } from 'doipjs'; + * + * const hkpProtocol = E.OpenPgpQueryProtocol.HKP; + * const hkpUrl = 'https://keys.openpgp.org/vks/v1/by-fingerprint/ABC123DEF456'; + * const hkpData = await fetcher.openpgp.fn({ url: hkpUrl, protocol: hkpProtocol }); + * + * const wkdProtocol = E.OpenPgpQueryProtocol.WKD; + * const wkdUrl = 'https://domain.example/.well-known/openpgpkey/hu/kei1q4tipxxu1yj79k9kfukdhfy631xe?l=alice'; + * const wkdData = await fetcher.openpgp.fn({ url: wkdUrl, protocol: wkdProtocol }); + */ + import axios from 'axios' import { readKey } from 'openpgp' import { OpenPgpQueryProtocol } from '../enums.js' @@ -21,9 +36,10 @@ import { parsePublicKey } from '../openpgp.js' import * as Types from '../types.js' /** - * Timeout after which the fetch is aborted + * Default timeout after which the fetch is aborted * @constant * @type {number} + * @default 5000 */ export const timeout = 5000 diff --git a/src/fetcher/telegram.js b/src/fetcher/telegram.js index 87ac7cc..080f555 100644 --- a/src/fetcher/telegram.js +++ b/src/fetcher/telegram.js @@ -13,15 +13,24 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Fetch proofs using Telegram groups + * @module fetcher/telegram + * @example + * import { fetcher } from 'doipjs'; + * const data = await fetcher.telegram.fn({ user: 'alice', chat: 'alice_identity_proof' }); + */ + import axios from 'axios' import isAscii from 'validator/lib/isAscii.js' import { version } from '../constants.js' import * as Types from '../types.js' /** - * Timeout after which the fetch is aborted + * Default timeout after which the fetch is aborted * @constant * @type {number} + * @default 5000 */ export const timeout = 5000 @@ -30,8 +39,8 @@ export const timeout = 5000 * @function * @async * @param {object} data - Data used in the request - * @param {string} data.chat - Telegram public chat username - * @param {string} data.user - Telegram user username + * @param {string} data.chat - Telegram public group name (slug) + * @param {string} data.user - Telegram username * @param {number} [data.fetcherTimeout] - Optional timeout for the fetcher * @param {Types.VerificationConfig} [opts] - Options used to enable the request * @returns {Promise} The fetched Telegram object diff --git a/src/fetcher/xmpp.js b/src/fetcher/xmpp.js index fca93ad..a3df785 100644 --- a/src/fetcher/xmpp.js +++ b/src/fetcher/xmpp.js @@ -13,6 +13,14 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Fetch proofs from XMPP accounts + * @module fetcher/xmpp + * @example + * import { fetcher } from 'doipjs'; + * const data = await fetcher.xmpp.fn({ id: 'alice@domain.example' }); + */ + import { client, xml } from '@xmpp/client' import debug from '@xmpp/debug' import isFQDN from 'validator/lib/isFQDN.js' @@ -20,9 +28,10 @@ import isAscii from 'validator/lib/isAscii.js' import * as Types from '../types.js' /** - * Timeout after which the fetch is aborted + * Default timeout after which the fetch is aborted * @constant * @type {number} + * @default 5000 */ export const timeout = 5000 @@ -31,6 +40,7 @@ let iqCaller = null /** * Start the XMPP client + * @ignore * @function * @async * @param {Types.XmppClaimVerificationConfig} params - XMPP claim verification config diff --git a/src/persona.js b/src/persona.js index 7daeb91..900d5dd 100644 --- a/src/persona.js +++ b/src/persona.js @@ -184,6 +184,7 @@ export class Persona { } /** + * @ignore * @param {object} personaObject - JSON representation of a persona * @returns {Persona | Error} Parsed persona */ diff --git a/src/profile.js b/src/profile.js index 7ac74d3..c03dc26 100644 --- a/src/profile.js +++ b/src/profile.js @@ -18,7 +18,7 @@ import { Persona } from './persona.js' import * as Types from './types.js' /** - * @class [Types.Profile] + * @class * @classdesc A profile of personas with identity claims * @param {Array} personas - Personas of the profile * @public @@ -157,6 +157,7 @@ export class Profile { } /** + * @ignore * @param {object} profileObject - JSON representation of the profile * @returns {Profile | Error} Parsed profile */ diff --git a/src/serviceProviders/activitypub.js b/src/serviceProviders/activitypub.js index d16d133..6445fd3 100644 --- a/src/serviceProviders/activitypub.js +++ b/src/serviceProviders/activitypub.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * ActivityPub service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/activitypub/) + * @module serviceProviders/activitypub + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.activitypub.processURI('https://domain.example/@alice'); + */ + import * as E from '../enums.js' import { fetcher } from '../index.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/aspe.js b/src/serviceProviders/aspe.js index f4412bb..ad30b74 100644 --- a/src/serviceProviders/aspe.js +++ b/src/serviceProviders/aspe.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * ASPE service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/aspe/) + * @module serviceProviders/aspe + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.activitypub.processURI('aspe:domain.example:abc123def456'); + */ + import isFQDN from 'validator/lib/isFQDN.js' import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/discourse.js b/src/serviceProviders/discourse.js index 1d2d01a..b74581b 100644 --- a/src/serviceProviders/discourse.js +++ b/src/serviceProviders/discourse.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Discourse service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/discourse/) + * @module serviceProviders/discourse + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.activitypub.processURI('https://domain.example/u/alice'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/dns.js b/src/serviceProviders/dns.js index 06c81ec..8548d4f 100644 --- a/src/serviceProviders/dns.js +++ b/src/serviceProviders/dns.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * DNS service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/dns/) + * @module serviceProviders/dns + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.dns.processURI('dns:domain.example?type=TXT'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/forem.js b/src/serviceProviders/forem.js index a49ec68..563ba36 100644 --- a/src/serviceProviders/forem.js +++ b/src/serviceProviders/forem.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Forem service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/forem/) + * @module serviceProviders/forem + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.forem.processURI('https://domain.example/alice/title'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/forgejo.js b/src/serviceProviders/forgejo.js index f1a14f6..ace5e6a 100644 --- a/src/serviceProviders/forgejo.js +++ b/src/serviceProviders/forgejo.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Forgejo service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/forgejo/) + * @module serviceProviders/forgejo + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.forgejo.processURI('https://domain.example/alice/repo'); + */ + import * as E from '../enums.js' import { fetcher } from '../index.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/gitea.js b/src/serviceProviders/gitea.js index 0cd2d72..aa98553 100644 --- a/src/serviceProviders/gitea.js +++ b/src/serviceProviders/gitea.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Gitea service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/gitea/) + * @module serviceProviders/gitea + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.gitea.processURI('https://domain.example/alice/repo'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/github.js b/src/serviceProviders/github.js index d0c36f8..6fa125c 100644 --- a/src/serviceProviders/github.js +++ b/src/serviceProviders/github.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Github service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/github/) + * @module serviceProviders/github + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.github.processURI('https://gist.github.com/alice/title'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/gitlab.js b/src/serviceProviders/gitlab.js index 7e5c8ae..f2291e7 100644 --- a/src/serviceProviders/gitlab.js +++ b/src/serviceProviders/gitlab.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Gitlab service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/gitlab/) + * @module serviceProviders/gitlab + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.gitlab.processURI('https://domain.example/alice/repo'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/hackernews.js b/src/serviceProviders/hackernews.js index 0c22b6b..607973c 100644 --- a/src/serviceProviders/hackernews.js +++ b/src/serviceProviders/hackernews.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Hackernews service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/hackernews/) + * @module serviceProviders/hackernews + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.hackernews.processURI('https://news.ycombinator.com/user?id=alice'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/irc.js b/src/serviceProviders/irc.js index 3992220..031e570 100644 --- a/src/serviceProviders/irc.js +++ b/src/serviceProviders/irc.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * IRC service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/irc/) + * @module serviceProviders/irc + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.irc.processURI('irc://domain.example/alice'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/keybase.js b/src/serviceProviders/keybase.js index 4773f4b..f6233e2 100644 --- a/src/serviceProviders/keybase.js +++ b/src/serviceProviders/keybase.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Keybase service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/keybase/) + * @module serviceProviders/keybase + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.keybase.processURI('https://keybase.io/alice'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/liberapay.js b/src/serviceProviders/liberapay.js index b18eea0..00c88ca 100644 --- a/src/serviceProviders/liberapay.js +++ b/src/serviceProviders/liberapay.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Liberapay service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/liberapay/) + * @module serviceProviders/liberapay + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.liberapay.processURI('https://liberapay.com/alice'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/lichess.js b/src/serviceProviders/lichess.js index 57e6dc1..1c921df 100644 --- a/src/serviceProviders/lichess.js +++ b/src/serviceProviders/lichess.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Lichess service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/lichess/) + * @module serviceProviders/lichess + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.lichess.processURI('https://lichess.org/@/alice'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/lobsters.js b/src/serviceProviders/lobsters.js index a988f98..8e9ac82 100644 --- a/src/serviceProviders/lobsters.js +++ b/src/serviceProviders/lobsters.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Lobste.rs service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/lobsters/) + * @module serviceProviders/lobsters + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.lobsters.processURI('https://lobste.rs/~alice'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/matrix.js b/src/serviceProviders/matrix.js index 884f2a8..4edd058 100644 --- a/src/serviceProviders/matrix.js +++ b/src/serviceProviders/matrix.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Matrix service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/matrix/) + * @module serviceProviders/matrix + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.matrix.processURI('matrix:u/...'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/opencollective.js b/src/serviceProviders/opencollective.js index b5847e4..a0155ae 100644 --- a/src/serviceProviders/opencollective.js +++ b/src/serviceProviders/opencollective.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * OpenCollective service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/opencollective/) + * @module serviceProviders/opencollective + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.opencollective.processURI('https://opencollective.com/alice'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/openpgp.js b/src/serviceProviders/openpgp.js index 048d3db..dacc667 100644 --- a/src/serviceProviders/openpgp.js +++ b/src/serviceProviders/openpgp.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * OpenPGP service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/openpgp/) + * @module serviceProviders/openpgp + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.openpgp.processURI('openpgp4fpr:ABC123DEF456'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/orcid.js b/src/serviceProviders/orcid.js index 0f6f478..50253c1 100644 --- a/src/serviceProviders/orcid.js +++ b/src/serviceProviders/orcid.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * ORCiD service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/orcid/) + * @module serviceProviders/orcid + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.orcid.processURI('https://orcid.org/123-456-789-123'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/owncast.js b/src/serviceProviders/owncast.js index 454f520..4817373 100644 --- a/src/serviceProviders/owncast.js +++ b/src/serviceProviders/owncast.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Owncast service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/owncast/) + * @module serviceProviders/owncast + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.owncast.processURI('https://domain.example'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/reddit.js b/src/serviceProviders/reddit.js index c92f857..4847dbb 100644 --- a/src/serviceProviders/reddit.js +++ b/src/serviceProviders/reddit.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Reddit service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/reddit/) + * @module serviceProviders/reddit + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.reddit.processURI('https://reddit.com/...'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/stackexchange.js b/src/serviceProviders/stackexchange.js index 34bb9a3..27032d9 100644 --- a/src/serviceProviders/stackexchange.js +++ b/src/serviceProviders/stackexchange.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * StackExchange service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/stackexchange/) + * @module serviceProviders/stackexchange + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.stackexchange.processURI('https://stackoverflow.com/users/123/alice'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/telegram.js b/src/serviceProviders/telegram.js index d15f8d4..88bb676 100644 --- a/src/serviceProviders/telegram.js +++ b/src/serviceProviders/telegram.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Telegram service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/telegram/) + * @module serviceProviders/telegram + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.telegram.processURI('https://t.me/alice?proof=mygroup'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/twitter.js b/src/serviceProviders/twitter.js index 14d81fe..8d466a0 100644 --- a/src/serviceProviders/twitter.js +++ b/src/serviceProviders/twitter.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * Twitter service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/twitter/) + * @module serviceProviders/twitter + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.twitter.processURI('https://twitter.com/alice/status/123456789'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js' diff --git a/src/serviceProviders/xmpp.js b/src/serviceProviders/xmpp.js index 8fc9c8f..bfa40d6 100644 --- a/src/serviceProviders/xmpp.js +++ b/src/serviceProviders/xmpp.js @@ -13,6 +13,16 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ +/** + * XMPP service provider + * + * Link: [Keyoxide documentation](https://docs.keyoxide.org/service-providers/xmpp/) + * @module serviceProviders/xmpp + * @example + * import { ServiceProviderDefinitions } from 'doipjs'; + * const sp = ServiceProviderDefinitions.data.xmpp.processURI('xmpp:alice@domain.example'); + */ + import * as E from '../enums.js' import { ServiceProvider } from '../serviceProvider.js'