@atproto/oauth-provider-api 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @atproto/oauth-provider-api
+
+## 0.0.1
+
+### Patch Changes
+
+- [#3640](https://github.com/bluesky-social/atproto/pull/3640) [`cc4122652`](https://github.com/bluesky-social/atproto/commit/cc4122652ed42ba55826c019d0ec57bf25df1ecd) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Exctracted types shared between OAuthProvider backand and it's UI into a separate package.

package/LICENSE.txt

@@ -0,0 +1,7 @@
+Dual MIT/Apache-2.0 License
+
+Copyright (c) 2022-2025 Bluesky PBC, and Contributors
+
+Except as otherwise noted in individual files, this software is licensed under the MIT license (<http://opensource.org/licenses/MIT>), or the Apache License, Version 2.0 (<http://www.apache.org/licenses/LICENSE-2.0>).
+
+Downstream projects and end users may chose either license individually, or both together, at their discretion. The motivation for this dual-licensing is the additional software patent assurance provided by Apache 2.0.

package/dist/api.d.ts

@@ -0,0 +1,62 @@
+import type { Account } from './types.js';
+export type ApiEndpoints = {
+    '/verify-handle-availability': {
+        input: VerifyHandleAvailabilityData;
+        output: {
+            available: true;
+        };
+    };
+    '/sign-up': {
+        input: SignUpData;
+        output: {
+            account: Account;
+            consentRequired: boolean;
+        };
+    };
+    '/sign-in': {
+        input: SignInData;
+        output: {
+            account: Account;
+            consentRequired: boolean;
+        };
+    };
+    '/reset-password-request': {
+        input: InitiatePasswordResetData;
+        output: {
+            success: true;
+        };
+    };
+    '/reset-password-confirm': {
+        input: ConfirmResetPasswordData;
+        output: {
+            success: true;
+        };
+    };
+};
+export type SignInData = {
+    locale: string;
+    username: string;
+    password: string;
+    emailOtp?: string;
+    remember?: boolean;
+};
+export type SignUpData = {
+    locale: string;
+    handle: string;
+    email: string;
+    password: string;
+    inviteCode?: string;
+    hcaptchaToken?: string;
+};
+export type InitiatePasswordResetData = {
+    locale: string;
+    email: string;
+};
+export type ConfirmResetPasswordData = {
+    token: string;
+    password: string;
+};
+export type VerifyHandleAvailabilityData = {
+    handle: string;
+};
+//# sourceMappingURL=api.d.ts.map

package/dist/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAKzC,MAAM,MAAM,YAAY,GAAG;IACzB,6BAA6B,EAAE;QAC7B,KAAK,EAAE,4BAA4B,CAAA;QACnC,MAAM,EAAE;YAAE,SAAS,EAAE,IAAI,CAAA;SAAE,CAAA;KAC5B,CAAA;IACD,UAAU,EAAE;QACV,KAAK,EAAE,UAAU,CAAA;QACjB,MAAM,EAAE;YACN,OAAO,EAAE,OAAO,CAAA;YAChB,eAAe,EAAE,OAAO,CAAA;SACzB,CAAA;KACF,CAAA;IACD,UAAU,EAAE;QACV,KAAK,EAAE,UAAU,CAAA;QACjB,MAAM,EAAE;YACN,OAAO,EAAE,OAAO,CAAA;YAChB,eAAe,EAAE,OAAO,CAAA;SACzB,CAAA;KACF,CAAA;IACD,yBAAyB,EAAE;QACzB,KAAK,EAAE,yBAAyB,CAAA;QAChC,MAAM,EAAE;YAAE,OAAO,EAAE,IAAI,CAAA;SAAE,CAAA;KAC1B,CAAA;IACD,yBAAyB,EAAE;QACzB,KAAK,EAAE,wBAAwB,CAAA;QAC/B,MAAM,EAAE;YAAE,OAAO,EAAE,IAAI,CAAA;SAAE,CAAA;KAC1B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,EAAE,MAAM,CAAA;CACf,CAAA"}

package/dist/api.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=api.js.map

package/dist/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":""}

package/dist/backend-types.d.ts

@@ -0,0 +1,26 @@
+import type { OAuthClientMetadata } from '@atproto/oauth-types';
+import type { LinkDefinition, ScopeDetail, Session } from './types.js';
+export type AvailableLocales = readonly string[];
+export type CustomizationData = {
+    hcaptchaSiteKey?: string;
+    inviteCodeRequired?: boolean;
+    availableUserDomains?: string[];
+    name?: string;
+    logo?: string;
+    links?: LinkDefinition[];
+};
+export type ErrorData = {
+    error: string;
+    error_description: string;
+};
+export type AuthorizeData = {
+    clientId: string;
+    clientMetadata: OAuthClientMetadata;
+    clientTrusted: boolean;
+    requestUri: string;
+    loginHint?: string;
+    scopeDetails?: ScopeDetail[];
+    newSessionsRequireConsent: boolean;
+    sessions: Session[];
+};
+//# sourceMappingURL=backend-types.d.ts.map

package/dist/backend-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"backend-types.d.ts","sourceRoot":"","sources":["../src/backend-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAA;AAC/D,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAKtE,MAAM,MAAM,gBAAgB,GAAG,SAAS,MAAM,EAAE,CAAA;AAEhD,MAAM,MAAM,iBAAiB,GAAG;IAE9B,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAA;IAG/B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,cAAc,EAAE,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,iBAAiB,EAAE,MAAM,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,EAAE,MAAM,CAAA;IAChB,cAAc,EAAE,mBAAmB,CAAA;IACnC,aAAa,EAAE,OAAO,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,WAAW,EAAE,CAAA;IAC5B,yBAAyB,EAAE,OAAO,CAAA;IAClC,QAAQ,EAAE,OAAO,EAAE,CAAA;CACpB,CAAA"}

package/dist/backend-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=backend-types.js.map

package/dist/backend-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"backend-types.js","sourceRoot":"","sources":["../src/backend-types.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export type * from './api.js';
+export type * from './backend-types.js';
+export type * from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,UAAU,CAAA;AAC7B,mBAAmB,oBAAoB,CAAA;AACvC,mBAAmB,YAAY,CAAA"}

package/dist/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/dist/types.d.ts

@@ -0,0 +1,29 @@
+export type Account = {
+    sub: string;
+    aud: string | [string, ...string[]];
+    email?: string;
+    email_verified?: boolean;
+    name?: string;
+    preferred_username?: string;
+    picture?: string;
+};
+export type Session = {
+    account: Account;
+    info?: never;
+    selected: boolean;
+    loginRequired: boolean;
+    consentRequired: boolean;
+};
+export type LocalizedString = string | ({
+    en: string;
+} & Record<string, string | undefined>);
+export type LinkDefinition = {
+    title: LocalizedString;
+    href: string;
+    rel?: string;
+};
+export type ScopeDetail = {
+    scope: string;
+    description?: string;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,OAAO,GAAG;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAA;IAEnC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,CAAC,EAAE,KAAK,CAAA;IAEZ,QAAQ,EAAE,OAAO,CAAA;IACjB,aAAa,EAAE,OAAO,CAAA;IACtB,eAAe,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,eAAe,GACvB,MAAM,GACN,CAAC;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAA;AAEzD,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,eAAe,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA"}

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@atproto/oauth-provider-api",
+  "version": "0.0.1",
+  "license": "MIT",
+  "description": "Shared data types for the @atproto/oauth-provider and @atproto/oauth-provider-ui packages",
+  "keywords": [
+    "atproto",
+    "oauth",
+    "provider",
+    "types"
+  ],
+  "homepage": "https://atproto.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bluesky-social/atproto",
+    "directory": "packages/oauth/oauth-provider-api"
+  },
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@atproto/oauth-types": "0.2.4"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.3"
+  },
+  "scripts": {
+    "build": "tsc --build tsconfig.build.json"
+  }
+}

package/src/api.ts

@@ -0,0 +1,64 @@
+import type { Account } from './types.js'
+
+// These are the endpoints implemented by the OAuth provider, for it's UI to
+// call.
+
+export type ApiEndpoints = {
+  '/verify-handle-availability': {
+    input: VerifyHandleAvailabilityData
+    output: { available: true }
+  }
+  '/sign-up': {
+    input: SignUpData
+    output: {
+      account: Account
+      consentRequired: boolean
+    }
+  }
+  '/sign-in': {
+    input: SignInData
+    output: {
+      account: Account
+      consentRequired: boolean
+    }
+  }
+  '/reset-password-request': {
+    input: InitiatePasswordResetData
+    output: { success: true }
+  }
+  '/reset-password-confirm': {
+    input: ConfirmResetPasswordData
+    output: { success: true }
+  }
+}
+
+export type SignInData = {
+  locale: string
+  username: string
+  password: string
+  emailOtp?: string
+  remember?: boolean
+}
+
+export type SignUpData = {
+  locale: string
+  handle: string
+  email: string
+  password: string
+  inviteCode?: string
+  hcaptchaToken?: string
+}
+
+export type InitiatePasswordResetData = {
+  locale: string
+  email: string
+}
+
+export type ConfirmResetPasswordData = {
+  token: string
+  password: string
+}
+
+export type VerifyHandleAvailabilityData = {
+  handle: string
+}

package/src/backend-types.ts

@@ -0,0 +1,35 @@
+import type { OAuthClientMetadata } from '@atproto/oauth-types'
+import type { LinkDefinition, ScopeDetail, Session } from './types.js'
+
+// These are the types of the variables that are injected into the HTML by the
+// backend. They are used to configure the frontend.
+
+export type AvailableLocales = readonly string[]
+
+export type CustomizationData = {
+  // Functional customization
+  hcaptchaSiteKey?: string
+  inviteCodeRequired?: boolean
+  availableUserDomains?: string[]
+
+  // Aesthetic customization
+  name?: string
+  logo?: string
+  links?: LinkDefinition[]
+}
+
+export type ErrorData = {
+  error: string
+  error_description: string
+}
+
+export type AuthorizeData = {
+  clientId: string
+  clientMetadata: OAuthClientMetadata
+  clientTrusted: boolean
+  requestUri: string
+  loginHint?: string
+  scopeDetails?: ScopeDetail[]
+  newSessionsRequireConsent: boolean
+  sessions: Session[]
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export type * from './api.js'
+export type * from './backend-types.js'
+export type * from './types.js'

package/src/types.ts

@@ -0,0 +1,34 @@
+export type Account = {
+  sub: string
+  aud: string | [string, ...string[]]
+
+  email?: string
+  email_verified?: boolean
+  name?: string
+  preferred_username?: string
+  picture?: string
+}
+
+export type Session = {
+  account: Account
+  info?: never // Prevent relying on this in the frontend
+
+  selected: boolean
+  loginRequired: boolean
+  consentRequired: boolean
+}
+
+export type LocalizedString =
+  | string
+  | ({ en: string } & Record<string, string | undefined>)
+
+export type LinkDefinition = {
+  title: LocalizedString
+  href: string
+  rel?: string
+}
+
+export type ScopeDetail = {
+  scope: string
+  description?: string
+}

package/tsconfig.build.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../../tsconfig/isomorphic.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist"
+  },
+  "include": ["./src"]
+}

package/tsconfig.build.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/api.ts","./src/backend-types.ts","./src/index.ts","./src/types.ts"],"version":"5.6.3"}

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "include": [],
+  "references": [{ "path": "./tsconfig.build.json" }]
+}