@junobuild/core-peer 3.4.1 → 4.0.0

package/dist/types/auth/providers/github.providers.d.ts

@@ -0,0 +1,14 @@
+import type { GitHubSignInRedirectOptions } from '../types/github';
+export declare class GitHubProvider {
+    /**
+     * Initiates a GitHub sign-in flow.
+     *
+     * @param {Object} params - Parameters for the sign-in request.
+     * @param {GitHubSignInRedirectOptions} [params.options] - Optional configuration for the sign-in request.
+     *
+     * @returns {Promise<void>} Resolves once the sign-in flow has been initiated.
+     */
+    signIn({ options }: {
+        options?: GitHubSignInRedirectOptions;
+    }): Promise<void>;
+}

package/dist/types/auth/services/redirect.services.d.ts

@@ -1 +1,2 @@
-export declare const handleRedirectCallback: () => Promise<void>;
+import type { HandleRedirectCallbackOptions } from '../types/auth';
+export declare const handleRedirectCallback: (options: HandleRedirectCallbackOptions) => Promise<void>;

package/dist/types/auth/types/auth.d.ts

@@ -1,3 +1,4 @@
+import type { GitHubHandleRedirectCallbackOptions, GitHubSignInRedirectOptions } from './github';
 import type { GoogleSignInRedirectOptions } from './google';
 import type { InternetIdentitySignInOptions } from './internet-identity';
 import type { WebAuthnSignInOptions, WebAuthnSignUpOptions } from './webauthn';
@@ -19,6 +20,7 @@ export interface SignInContext {
  * Defines which provider to use for signing in and its associated options.
  *
  * - `google` — Google sign-in
+ * - `github` — GitHub sign-in
  * - `internet_identity` — Internet Identity
  * - `webauthn` — WebAuthn/Passkeys
  */
@@ -26,6 +28,10 @@ export type SignInOptions = {
     google: {
         options?: GoogleSignInRedirectOptions;
     };
+} | {
+    github: {
+        options?: GitHubSignInRedirectOptions;
+    };
 } | {
     internet_identity: {
         options?: InternetIdentitySignInOptions;
@@ -60,3 +66,16 @@ export interface SignOutOptions {
      */
     windowReload?: boolean;
 }
+/**
+ * Defines which redirect should be handled.
+ *
+ * - `google`: Google sign-in
+ * - `github`: GitHub sign-in
+ */
+export type HandleRedirectCallbackOptions = {
+    google: null;
+} | {
+    github: {
+        options: GitHubHandleRedirectCallbackOptions;
+    } | null;
+};

package/dist/types/auth/types/github.d.ts

@@ -0,0 +1,56 @@
+export type AuthScope = 'openid' | 'profile' | 'email';
+/**
+ * Combination of OAuth scopes supported by GitHub.
+ *
+ * - `'read:user'` is always required.
+ * - `'user:email'` is optional.
+ *
+ * @see https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps
+ */
+export type GitHubAuthScopes = ['read:user', 'user:email'] | ['read:user'];
+/**
+ * Sign-in options for the GitHub provider using a redirect flow.
+ * @interface GitHubSignInRedirectOptions
+ */
+export interface GitHubSignInRedirectOptions {
+    /**
+     * Redirect configuration.
+     */
+    redirect?: GitHubRedirectOptions;
+}
+/**
+ * Redirect options for GitHub sign-in.
+ */
+export interface GitHubRedirectOptions {
+    /**
+     * GitHub OAuth client ID.
+     * If omitted, the library attempts to read it from `juno.config`.
+     */
+    clientId?: string;
+    /**
+     * OAuth scopes to request.
+     * Must begin with `'openid'` and include `'profile'`, `'email'`, or both.
+     * @default ['openid', 'profile', 'email']
+     */
+    authScopes?: GitHubAuthScopes;
+    /**
+     * Redirect URL after authentication.
+     * @default window.location.origin
+     */
+    redirectUrl?: string;
+    /**
+     * Initialization URL. Useful for local development or to interact with a self-hosted API.
+     * @default https://api.juno.build/v1/auth/init/github
+     */
+    initUrl?: string;
+}
+/**
+ * Options for handling GitHub redirect callback.
+ */
+export interface GitHubHandleRedirectCallbackOptions {
+    /**
+     * Finalization URL. Useful for local development or to interact with a self-hosted API.
+     * @default https://api.juno.build/v1/auth/finalize/github
+     */
+    finalizeUrl?: string;
+}

package/dist/types/auth/types/google.d.ts

@@ -1,4 +1,3 @@
-export type AuthScope = 'openid' | 'profile' | 'email';
 /**
  * Combination of OAuth scopes supported by Google.
  *

package/dist/types/auth/utils/url.utils.d.ts

@@ -0,0 +1,3 @@
+export declare const parseOptionalUrl: ({ url }: {
+    url: string;
+}) => URL | null;

package/dist/types/core/utils/window.env.utils.d.ts

@@ -1,3 +1,5 @@
 export declare const envSatelliteId: () => string | undefined;
 export declare const envContainer: () => string | undefined;
 export declare const envGoogleClientId: () => string | undefined;
+export declare const envGitHubClientId: () => string | undefined;
+export declare const envApiUrl: () => string | undefined;

package/dist/types/index.d.ts

@@ -12,10 +12,13 @@ export { signUp } from './auth/services/sign-up.services';
 export type * from './auth/types/auth';
 export * from './auth/types/auth-client';
 export * from './auth/types/errors';
+export type * from './auth/types/github';
+export type * from './auth/types/google';
+export type * from './auth/types/internet-identity';
 export type * from './auth/types/progress';
 export type * from './auth/types/provider';
 export type * from './auth/types/user';
-export * from './auth/types/webauthn';
+export type * from './auth/types/webauthn';
 export * from './auth/utils/user.utils';
 export type * from './core/types/env';
 export { ListOrder, ListPaginate, ListParams, ListResults } from './core/types/list';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@junobuild/core-peer",
-  "version": "3.4.1",
+  "version": "4.0.0",
   "description": "JavaScript core client for Juno (deprecated, use @junobuild/core)",
   "author": "David Dal Busco (https://daviddalbusco.com)",
   "license": "MIT",
@@ -54,7 +54,7 @@
   ],
   "homepage": "https://juno.build",
   "dependencies": {
-    "@junobuild/auth": "^2.1",
+    "@junobuild/auth": "^3",
     "@junobuild/errors": "*",
     "@junobuild/ic-client": "^7.1",
     "@junobuild/storage": "^2.2",