@atproto/oauth-scopes/dist/atproto-oauth-scope.js

A library for manipulating and validating ATproto OAuth scopes in TypeScript.

import { isScopeStringFor } from './lib/syntax.js';
import { isNonNullable } from './lib/util.js';
import { AccountPermission } from './scopes/account-permission.js';
import { BlobPermission } from './scopes/blob-permission.js';
import { IdentityPermission } from './scopes/identity-permission.js';
import { IncludeScope } from './scopes/include-scope.js';
import { RepoPermission } from './scopes/repo-permission.js';
import { RpcPermission } from './scopes/rpc-permission.js';
export { isScopeStringFor };
export const STATIC_SCOPE_VALUES = Object.freeze([
    'atproto',
    'transition:email',
    'transition:generic',
    'transition:chat.bsky',
]);
export function isStaticScopeValue(value) {
    return STATIC_SCOPE_VALUES.includes(value);
}
/**
 * @note This function does not only verify the scope string format (with
 * {@link isScopeStringFor}), but also checks if the provided parameters are
 * valid according to the respective scope syntax definition. This allows
 * excluding scopes that cannot be fully interpreted by the current version of
 * the code.
 */
export function isAtprotoOauthScope(value) {
    return (isStaticScopeValue(value) ||
        AccountPermission.fromString(value) != null ||
        BlobPermission.fromString(value) != null ||
        IdentityPermission.fromString(value) != null ||
        IncludeScope.fromString(value) != null ||
        RepoPermission.fromString(value) != null ||
        RpcPermission.fromString(value) != null);
}
export function normalizeAtprotoOauthScope(scope) {
    return scope
        .split(' ')
        .map(normalizeAtprotoOauthScopeValue)
        .filter(isNonNullable)
        .sort()
        .join(' ');
}
export function normalizeAtprotoOauthScopeValue(value) {
    if (isStaticScopeValue(value))
        return value;
    for (const Scope of [
        AccountPermission,
        BlobPermission,
        IdentityPermission,
        IncludeScope,
        RepoPermission,
        RpcPermission,
    ]) {
        const parsed = Scope.fromString(value);
        if (parsed)
            return parsed.toString();
    }
    return null;
}
//# sourceMappingURL=atproto-oauth-scope.js.map