@atproto/oauth-scopes 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atproto/oauth-scopes
 
+## 0.2.0
+
+### Minor Changes
+
+- [#4149](https://github.com/bluesky-social/atproto/pull/4149) [`8914f9abd`](https://github.com/bluesky-social/atproto/commit/8914f9abde2059c551d7e4c8d104227986098b82) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Method `authenticateRequest` now returns `SignedTokenPayload`
+
+### Patch Changes
+
+- [#4149](https://github.com/bluesky-social/atproto/pull/4149) [`8914f9abd`](https://github.com/bluesky-social/atproto/commit/8914f9abde2059c551d7e4c8d104227986098b82) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Add scope normalization utility
+
+- Updated dependencies []:
+  - @atproto/lexicon@0.5.1
+
 ## 0.1.0
 
 ### Minor Changes

package/dist/atproto-oauth-scope.d.ts

@@ -1,6 +1,9 @@
 import { ScopeStringFor, isScopeStringFor } from './lib/syntax.js';
 export { type ScopeStringFor, isScopeStringFor };
-export type AtprotoOauthScope = 'atproto' | 'transition:email' | 'transition:generic' | 'transition:chat.bsky' | ScopeStringFor<'account'> | ScopeStringFor<'blob'> | ScopeStringFor<'identity'> | ScopeStringFor<'include'> | ScopeStringFor<'repo'> | ScopeStringFor<'rpc'>;
+export declare const STATIC_SCOPE_VALUES: readonly ["atproto", "transition:email", "transition:generic", "transition:chat.bsky"];
+export type StaticScopeValue = (typeof STATIC_SCOPE_VALUES)[number];
+export declare function isStaticScopeValue(value: string): value is StaticScopeValue;
+export type AtprotoOauthScope = StaticScopeValue | ScopeStringFor<'account'> | ScopeStringFor<'blob'> | ScopeStringFor<'identity'> | ScopeStringFor<'include'> | ScopeStringFor<'repo'> | ScopeStringFor<'rpc'>;
 /**
  * @note This function does not only verify the scope string format (with
  * {@link isScopeStringFor}), but also checks if the provided parameters are
@@ -9,4 +12,6 @@ export type AtprotoOauthScope = 'atproto' | 'transition:email' | 'transition:gen
  * the code.
  */
 export declare function isAtprotoOauthScope(value: string): value is AtprotoOauthScope;
+export declare function normalizeAtprotoOauthScope(scope: string): string;
+export declare function normalizeAtprotoOauthScopeValue(value: string): AtprotoOauthScope | null;
 //# sourceMappingURL=atproto-oauth-scope.d.ts.map

package/dist/atproto-oauth-scope.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"atproto-oauth-scope.d.ts","sourceRoot":"","sources":["../src/atproto-oauth-scope.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAQlE,OAAO,EAAE,KAAK,cAAc,EAAE,gBAAgB,EAAE,CAAA;AAEhD,MAAM,MAAM,iBAAiB,GACzB,SAAS,GACT,kBAAkB,GAClB,oBAAoB,GACpB,sBAAsB,GACtB,cAAc,CAAC,SAAS,CAAC,GACzB,cAAc,CAAC,MAAM,CAAC,GACtB,cAAc,CAAC,UAAU,CAAC,GAC1B,cAAc,CAAC,SAAS,CAAC,GACzB,cAAc,CAAC,MAAM,CAAC,GACtB,cAAc,CAAC,KAAK,CAAC,CAAA;AAEzB;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,iBAAiB,CAa7E"}
+{"version":3,"file":"atproto-oauth-scope.d.ts","sourceRoot":"","sources":["../src/atproto-oauth-scope.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AASlE,OAAO,EAAE,KAAK,cAAc,EAAE,gBAAgB,EAAE,CAAA;AAEhD,eAAO,MAAM,mBAAmB,wFAKrB,CAAA;AAEX,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAA;AACnE,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,gBAAgB,CAE3E;AAED,MAAM,MAAM,iBAAiB,GACzB,gBAAgB,GAChB,cAAc,CAAC,SAAS,CAAC,GACzB,cAAc,CAAC,MAAM,CAAC,GACtB,cAAc,CAAC,UAAU,CAAC,GAC1B,cAAc,CAAC,SAAS,CAAC,GACzB,cAAc,CAAC,MAAM,CAAC,GACtB,cAAc,CAAC,KAAK,CAAC,CAAA;AAEzB;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,iBAAiB,CAU7E;AAED,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,MAAM,UAOvD;AAED,wBAAgB,+BAA+B,CAC7C,KAAK,EAAE,MAAM,GACZ,iBAAiB,GAAG,IAAI,CAgB1B"}

package/dist/atproto-oauth-scope.js

@@ -1,15 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isScopeStringFor = void 0;
+exports.STATIC_SCOPE_VALUES = exports.isScopeStringFor = void 0;
+exports.isStaticScopeValue = isStaticScopeValue;
 exports.isAtprotoOauthScope = isAtprotoOauthScope;
+exports.normalizeAtprotoOauthScope = normalizeAtprotoOauthScope;
+exports.normalizeAtprotoOauthScopeValue = normalizeAtprotoOauthScopeValue;
 const syntax_js_1 = require("./lib/syntax.js");
 Object.defineProperty(exports, "isScopeStringFor", { enumerable: true, get: function () { return syntax_js_1.isScopeStringFor; } });
+const util_js_1 = require("./lib/util.js");
 const account_permission_js_1 = require("./scopes/account-permission.js");
 const blob_permission_js_1 = require("./scopes/blob-permission.js");
 const identity_permission_js_1 = require("./scopes/identity-permission.js");
 const include_scope_js_1 = require("./scopes/include-scope.js");
 const repo_permission_js_1 = require("./scopes/repo-permission.js");
 const rpc_permission_js_1 = require("./scopes/rpc-permission.js");
+exports.STATIC_SCOPE_VALUES = Object.freeze([
+    'atproto',
+    'transition:email',
+    'transition:generic',
+    'transition:chat.bsky',
+]);
+function isStaticScopeValue(value) {
+    return exports.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
@@ -18,10 +31,7 @@ const rpc_permission_js_1 = require("./scopes/rpc-permission.js");
  * the code.
  */
 function isAtprotoOauthScope(value) {
-    return (value === 'atproto' ||
-        value === 'transition:email' ||
-        value === 'transition:generic' ||
-        value === 'transition:chat.bsky' ||
+    return (isStaticScopeValue(value) ||
         account_permission_js_1.AccountPermission.fromString(value) != null ||
         blob_permission_js_1.BlobPermission.fromString(value) != null ||
         identity_permission_js_1.IdentityPermission.fromString(value) != null ||
@@ -29,4 +39,29 @@ function isAtprotoOauthScope(value) {
         repo_permission_js_1.RepoPermission.fromString(value) != null ||
         rpc_permission_js_1.RpcPermission.fromString(value) != null);
 }
+function normalizeAtprotoOauthScope(scope) {
+    return scope
+        .split(' ')
+        .map(normalizeAtprotoOauthScopeValue)
+        .filter(util_js_1.isNonNullable)
+        .sort()
+        .join(' ');
+}
+function normalizeAtprotoOauthScopeValue(value) {
+    if (isStaticScopeValue(value))
+        return value;
+    for (const Scope of [
+        account_permission_js_1.AccountPermission,
+        blob_permission_js_1.BlobPermission,
+        identity_permission_js_1.IdentityPermission,
+        include_scope_js_1.IncludeScope,
+        repo_permission_js_1.RepoPermission,
+        rpc_permission_js_1.RpcPermission,
+    ]) {
+        const parsed = Scope.fromString(value);
+        if (parsed)
+            return parsed.toString();
+    }
+    return null;
+}
 //# sourceMappingURL=atproto-oauth-scope.js.map

package/dist/atproto-oauth-scope.js.map

@@ -1 +1 @@
-{"version":3,"file":"atproto-oauth-scope.js","sourceRoot":"","sources":["../src/atproto-oauth-scope.ts"],"names":[],"mappings":";;;AA6BA,kDAaC;AA1CD,+CAAkE;AAQpC,iGARL,4BAAgB,OAQK;AAP9C,0EAAkE;AAClE,oEAA4D;AAC5D,4EAAoE;AACpE,gEAAwD;AACxD,oEAA4D;AAC5D,kEAA0D;AAgB1D;;;;;;GAMG;AACH,SAAgB,mBAAmB,CAAC,KAAa;IAC/C,OAAO,CACL,KAAK,KAAK,SAAS;QACnB,KAAK,KAAK,kBAAkB;QAC5B,KAAK,KAAK,oBAAoB;QAC9B,KAAK,KAAK,sBAAsB;QAChC,yCAAiB,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI;QAC3C,mCAAc,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI;QACxC,2CAAkB,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI;QAC5C,+BAAY,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI;QACtC,mCAAc,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI;QACxC,iCAAa,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI,CACxC,CAAA;AACH,CAAC"}
+{"version":3,"file":"atproto-oauth-scope.js","sourceRoot":"","sources":["../src/atproto-oauth-scope.ts"],"names":[],"mappings":";;;AAmBA,gDAEC;AAkBD,kDAUC;AAED,gEAOC;AAED,0EAkBC;AA9ED,+CAAkE;AASpC,iGATL,4BAAgB,OASK;AAR9C,2CAA6C;AAC7C,0EAAkE;AAClE,oEAA4D;AAC5D,4EAAoE;AACpE,gEAAwD;AACxD,oEAA4D;AAC5D,kEAA0D;AAI7C,QAAA,mBAAmB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC/C,SAAS;IACT,kBAAkB;IAClB,oBAAoB;IACpB,sBAAsB;CACd,CAAC,CAAA;AAGX,SAAgB,kBAAkB,CAAC,KAAa;IAC9C,OAAQ,2BAAyC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;AACnE,CAAC;AAWD;;;;;;GAMG;AACH,SAAgB,mBAAmB,CAAC,KAAa;IAC/C,OAAO,CACL,kBAAkB,CAAC,KAAK,CAAC;QACzB,yCAAiB,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI;QAC3C,mCAAc,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI;QACxC,2CAAkB,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI;QAC5C,+BAAY,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI;QACtC,mCAAc,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI;QACxC,iCAAa,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI,CACxC,CAAA;AACH,CAAC;AAED,SAAgB,0BAA0B,CAAC,KAAa;IACtD,OAAO,KAAK;SACT,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,+BAA+B,CAAC;SACpC,MAAM,CAAC,uBAAa,CAAC;SACrB,IAAI,EAAE;SACN,IAAI,CAAC,GAAG,CAAC,CAAA;AACd,CAAC;AAED,SAAgB,+BAA+B,CAC7C,KAAa;IAEb,IAAI,kBAAkB,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAA;IAE3C,KAAK,MAAM,KAAK,IAAI;QAClB,yCAAiB;QACjB,mCAAc;QACd,2CAAkB;QAClB,+BAAY;QACZ,mCAAc;QACd,iCAAa;KACd,EAAE,CAAC;QACF,MAAM,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;QACtC,IAAI,MAAM;YAAE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAA;IACtC,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC"}

package/dist/lib/util.d.ts

@@ -3,4 +3,5 @@ export interface Matchable<T> {
 }
 export declare function minIdx(a: number, b: number): number;
 export declare function knownValuesValidator<T>(values: Iterable<T>): (value: unknown) => value is T;
+export declare function isNonNullable<T>(value: T): value is NonNullable<T>;
 //# sourceMappingURL=util.d.ts.map

package/dist/lib/util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../src/lib/util.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,OAAO,CAAC,OAAO,EAAE,CAAC,GAAG,OAAO,CAAA;CAC7B;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAInD;AAED,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,IAEjD,OAAO,OAAO,KAAG,KAAK,IAAI,CAAC,CACpC"}
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../src/lib/util.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,OAAO,CAAC,OAAO,EAAE,CAAC,GAAG,OAAO,CAAA;CAC7B;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAInD;AAED,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,IAEjD,OAAO,OAAO,KAAG,KAAK,IAAI,CAAC,CACpC;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,IAAI,WAAW,CAAC,CAAC,CAAC,CAElE"}

package/dist/lib/util.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.minIdx = minIdx;
 exports.knownValuesValidator = knownValuesValidator;
+exports.isNonNullable = isNonNullable;
 function minIdx(a, b) {
     if (a === -1)
         return b;
@@ -13,4 +14,7 @@ function knownValuesValidator(values) {
     const set = new Set(values);
     return (value) => set.has(value);
 }
+function isNonNullable(value) {
+    return value != null;
+}
 //# sourceMappingURL=util.js.map

package/dist/lib/util.js.map

@@ -1 +1 @@
-{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/lib/util.ts"],"names":[],"mappings":";;AAIA,wBAIC;AAED,oDAGC;AATD,SAAgB,MAAM,CAAC,CAAS,EAAE,CAAS;IACzC,IAAI,CAAC,KAAK,CAAC,CAAC;QAAE,OAAO,CAAC,CAAA;IACtB,IAAI,CAAC,KAAK,CAAC,CAAC;QAAE,OAAO,CAAC,CAAA;IACtB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AACvB,CAAC;AAED,SAAgB,oBAAoB,CAAI,MAAmB;IACzD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAU,MAAM,CAAC,CAAA;IACpC,OAAO,CAAC,KAAc,EAAc,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;AACvD,CAAC"}
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/lib/util.ts"],"names":[],"mappings":";;AAIA,wBAIC;AAED,oDAGC;AAED,sCAEC;AAbD,SAAgB,MAAM,CAAC,CAAS,EAAE,CAAS;IACzC,IAAI,CAAC,KAAK,CAAC,CAAC;QAAE,OAAO,CAAC,CAAA;IACtB,IAAI,CAAC,KAAK,CAAC,CAAC;QAAE,OAAO,CAAC,CAAA;IACtB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AACvB,CAAC;AAED,SAAgB,oBAAoB,CAAI,MAAmB;IACzD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAU,MAAM,CAAC,CAAA;IACpC,OAAO,CAAC,KAAc,EAAc,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;AACvD,CAAC;AAED,SAAgB,aAAa,CAAI,KAAQ;IACvC,OAAO,KAAK,IAAI,IAAI,CAAA;AACtB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/oauth-scopes",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "MIT",
   "description": "A library for manipulating and validating ATproto OAuth scopes in TypeScript.",
   "keywords": [
@@ -26,7 +26,7 @@
   },
   "dependencies": {
     "@atproto/did": "^0.2.0",
-    "@atproto/lexicon": "^0.5.0",
+    "@atproto/lexicon": "^0.5.1",
     "@atproto/syntax": "^0.4.1"
   },
   "devDependencies": {

package/src/atproto-oauth-scope.ts

@@ -1,4 +1,5 @@
 import { ScopeStringFor, 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'
@@ -8,11 +9,20 @@ import { RpcPermission } from './scopes/rpc-permission.js'
 
 export { type ScopeStringFor, isScopeStringFor }
 
+export const STATIC_SCOPE_VALUES = Object.freeze([
+  'atproto',
+  'transition:email',
+  'transition:generic',
+  'transition:chat.bsky',
+] as const)
+
+export type StaticScopeValue = (typeof STATIC_SCOPE_VALUES)[number]
+export function isStaticScopeValue(value: string): value is StaticScopeValue {
+  return (STATIC_SCOPE_VALUES as readonly string[]).includes(value)
+}
+
 export type AtprotoOauthScope =
-  | 'atproto'
-  | 'transition:email'
-  | 'transition:generic'
-  | 'transition:chat.bsky'
+  | StaticScopeValue
   | ScopeStringFor<'account'>
   | ScopeStringFor<'blob'>
   | ScopeStringFor<'identity'>
@@ -29,10 +39,7 @@ export type AtprotoOauthScope =
  */
 export function isAtprotoOauthScope(value: string): value is AtprotoOauthScope {
   return (
-    value === 'atproto' ||
-    value === 'transition:email' ||
-    value === 'transition:generic' ||
-    value === 'transition:chat.bsky' ||
+    isStaticScopeValue(value) ||
     AccountPermission.fromString(value) != null ||
     BlobPermission.fromString(value) != null ||
     IdentityPermission.fromString(value) != null ||
@@ -41,3 +48,32 @@ export function isAtprotoOauthScope(value: string): value is AtprotoOauthScope {
     RpcPermission.fromString(value) != null
   )
 }
+
+export function normalizeAtprotoOauthScope(scope: string) {
+  return scope
+    .split(' ')
+    .map(normalizeAtprotoOauthScopeValue)
+    .filter(isNonNullable)
+    .sort()
+    .join(' ')
+}
+
+export function normalizeAtprotoOauthScopeValue(
+  value: string,
+): AtprotoOauthScope | null {
+  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
+}

package/src/lib/util.ts

@@ -12,3 +12,7 @@ export function knownValuesValidator<T>(values: Iterable<T>) {
   const set = new Set<unknown>(values)
   return (value: unknown): value is T => set.has(value)
 }
+
+export function isNonNullable<T>(value: T): value is NonNullable<T> {
+  return value != null
+}