firstly 0.0.4 → 0.0.5

package/esm/auth/index.js

@@ -3,21 +3,22 @@ import { DEV } from 'esm-env';
 import { Lucia, TimeSpan } from 'lucia';
 import { remult } from 'remult';
 import { Log, red } from '@kitql/helpers';
-import { read } from '@kitql/internals';
-import { KitRole } from '../';
+import { getRelativePackagePath, read } from '@kitql/internals';
+import { env } from '$env/dynamic/private';
+import { FF_Role } from '../';
 import { RemultLuciaAdapter } from './Adapter';
 import { AuthControllerServer } from './AuthController.server';
 import { Auth } from './client';
-import { AuthProvider, KitAuthAccount, KitAuthRole, KitAuthUser, KitAuthUserSession, } from './Entities';
+import { FF_Auth_Role, FFAuthAccount, FFAuthProvider, FFAuthUser, FFAuthUserSession, } from './Entities';
 import { createSession } from './helper';
 import { initRoleFromEnv } from './RoleHelpers';
-export { KitAuthUser, KitAuthAccount, AuthProvider, KitAuthUserSession };
+export { FFAuthUser, FFAuthAccount, FFAuthProvider, FFAuthUserSession };
 export const logAuth = new Log('firstly | auth');
-export { KitAuthRole } from './Entities';
+export { FF_Auth_Role } from './Entities';
 export let AUTH_OPTIONS = {};
 export const getSafeOptions = () => {
     const signUp = AUTH_OPTIONS.signUp ?? true;
-    const base = AUTH_OPTIONS.ui === false ? 'NO_BASE_PATH' : AUTH_OPTIONS.ui?.paths?.base ?? '/fly/auth';
+    const base = AUTH_OPTIONS.ui === false ? 'NO_BASE_PATH' : AUTH_OPTIONS.ui?.paths?.base ?? '/ff/auth';
     const oAuths = AUTH_OPTIONS.providers?.oAuths?.map((o) => {
         return o.name;
     }) ?? [];
@@ -59,9 +60,9 @@ export const getSafeOptions = () => {
         redirectUrl = '/';
     }
     return {
-        User: AUTH_OPTIONS.customEntities?.User ?? KitAuthUser,
-        Session: AUTH_OPTIONS.customEntities?.Session ?? KitAuthUserSession,
-        Account: AUTH_OPTIONS.customEntities?.Account ?? KitAuthAccount,
+        User: AUTH_OPTIONS.customEntities?.User ?? FFAuthUser,
+        Session: AUTH_OPTIONS.customEntities?.Session ?? FFAuthUserSession,
+        Account: AUTH_OPTIONS.customEntities?.Account ?? FFAuthAccount,
         signUp,
         password_enabled: AUTH_OPTIONS.providers?.password ? true : false,
         otp_enabled: AUTH_OPTIONS.providers?.otp ? true : false,
@@ -120,7 +121,7 @@ export const auth = (o) => {
                 }
                 const account = await remult
                     .repo(oSafe.Account)
-                    .findFirst({ token, provider: AuthProvider.PASSWORD.id });
+                    .findFirst({ token, provider: FFAuthProvider.PASSWORD.id });
                 if (!account) {
                     throw new Error('Invalid token');
                 }
@@ -136,11 +137,13 @@ export const auth = (o) => {
                 await createSession(account.userId);
                 redirect(302, oSafe.redirectUrl);
             }
-            // When building firstly...
-            // let staticPath = './src/lib/auth/static/'
-            // For users...
-            const staticPath = './node_modules/firstly/esm/auth/static/';
-            // TODO: We can't use `DEV` switch because users are also in DEV mode... Maybe we should check if files exist?!?
+            // For lib author (us), it's good to have this local path.
+            let staticPath = './src/lib/auth/static/';
+            // For users, let's serve the static files from the installed package
+            const installedFirstlyPath = getRelativePackagePath('firstly');
+            if (installedFirstlyPath) {
+                staticPath = `${installedFirstlyPath}/esm/auth/static/`;
+            }
             if (event.url.pathname.startsWith(oSafe.firstlyData.props.ui.paths.base)) {
                 const content = read(`${staticPath}index.html`);
                 return {
@@ -251,9 +254,8 @@ export const auth = (o) => {
             return { early: false };
         },
         initApi: async () => {
-            // Todo... need to pass env to options
-            await initRoleFromEnv(logAuth, oSafe.User, 'KIT_ADMIN', KitRole.Admin);
-            await initRoleFromEnv(logAuth, oSafe.User, 'KIT_AUTH_ADMIN', KitAuthRole.Admin);
+            await initRoleFromEnv(logAuth, oSafe.User, env.FF_ADMIN, FF_Role.Admin);
+            await initRoleFromEnv(logAuth, oSafe.User, env.FF_AUTH_ADMIN, FF_Auth_Role.Admin);
         },
     };
 };

package/esm/auth/providers/github.d.ts

@@ -1,25 +1,30 @@
 import { GitHub } from 'arctic';
-import { type KitOAuth2Provider } from '../';
+import { type FFOAuth2Provider } from '../';
 /**
- * GitHub OAuth2 provider
+ * ## GitHub OAuth2 provider
  *
- * In GitHub, set your callback url to
- * - dev: `http://localhost:5173/api/auth_callback`
- * - prod: `https://MY_SUPER_SITE/api/auth_callback`
- *
- * In your project add a `.env` file with the following:
- *
- * ```env
- * GITHUB_CLIENT_ID= 'your-client-id'
- * GITHUB_CLIENT_SECRET= 'your-client-secret'
+ * 1. Get your **id** & **secret** from [GitHub (direct link)](https://github.com/settings/developers).
+ * 2. In GitHub, set your callback url to
+ * - [ ] dev: `http://localhost:5173/api/auth_callback`
+ * - [ ] prod: `https://MY_SUPER_SITE/api/auth_callback`
+ * 3. In your project add a `.env` file with the following:
+ * ```bash
+ * GITHUB_CLIENT_ID = 'your-client-id'
+ * GITHUB_CLIENT_SECRET = 'your-client-secret'
+ * # GITHUB_REDIRECT_URI = '' # optional, will default to "${origin}/api/auth_callback"
  * ```
- *
- * _FYI: GITHUB_REDIRECT_URI is optional as auth module will default to "${origin}/api/auth_callback"._
+ * 4. In your frontend, under a button click call something like:
+ * ```ts
+ * async function oauth() {
+ *   window.location.href = await Auth.signInOAuthGetUrl({ provider: 'github', redirect: window.location.pathname })
+ * }
+ * ```
+ * 5. Enjoy 🥳
  */
 export declare function github(options?: {
-    GITHUB_CLIENT_ID: string;
-    GITHUB_CLIENT_SECRET: string;
+    GITHUB_CLIENT_ID?: string;
+    GITHUB_CLIENT_SECRET?: string;
     GITHUB_REDIRECT_URI?: string;
-    authorizationURLOptions?: ReturnType<KitOAuth2Provider<'github', GitHub>['authorizationURLOptions']>;
+    authorizationURLOptions?: ReturnType<FFOAuth2Provider<'github', GitHub>['authorizationURLOptions']>;
     log?: boolean;
-}): KitOAuth2Provider<'github', GitHub>;
+}): FFOAuth2Provider<'github', GitHub>;

package/esm/auth/providers/github.js

@@ -1,34 +1,48 @@
 import { GitHub } from 'arctic';
 import { remult } from 'remult';
+import { env } from '$env/dynamic/private';
 import { checkOAuthConfig } from '.';
 import { logAuth } from '../';
+//------------------------------
+// For developers (future me ?), To do another OAuth2 provider:
+// Replace GITHUB / Github / github
+// update "https://github.com/settings/developers" to the correct URL (2 places)
+// update "https://api.github.com/user" the fetch user info
+//------------------------------
 /**
- * GitHub OAuth2 provider
+ * ## GitHub OAuth2 provider
  *
- * In GitHub, set your callback url to
- * - dev: `http://localhost:5173/api/auth_callback`
- * - prod: `https://MY_SUPER_SITE/api/auth_callback`
- *
- * In your project add a `.env` file with the following:
- *
- * ```env
- * GITHUB_CLIENT_ID= 'your-client-id'
- * GITHUB_CLIENT_SECRET= 'your-client-secret'
+ * 1. Get your **id** & **secret** from [GitHub (direct link)](https://github.com/settings/developers).
+ * 2. In GitHub, set your callback url to
+ * - [ ] dev: `http://localhost:5173/api/auth_callback`
+ * - [ ] prod: `https://MY_SUPER_SITE/api/auth_callback`
+ * 3. In your project add a `.env` file with the following:
+ * ```bash
+ * GITHUB_CLIENT_ID = 'your-client-id'
+ * GITHUB_CLIENT_SECRET = 'your-client-secret'
+ * # GITHUB_REDIRECT_URI = '' # optional, will default to "${origin}/api/auth_callback"
  * ```
- *
- * _FYI: GITHUB_REDIRECT_URI is optional as auth module will default to "${origin}/api/auth_callback"._
+ * 4. In your frontend, under a button click call something like:
+ * ```ts
+ * async function oauth() {
+ *   window.location.href = await Auth.signInOAuthGetUrl({ provider: 'github', redirect: window.location.pathname })
+ * }
+ * ```
+ * 5. Enjoy 🥳
  */
 export function github(options) {
     const name = 'github';
-    const clientID = options?.GITHUB_CLIENT_ID ?? '';
-    const secret = options?.GITHUB_CLIENT_SECRET ?? '';
+    const clientID = options?.GITHUB_CLIENT_ID ?? env.GITHUB_CLIENT_ID ?? '';
+    const secret = options?.GITHUB_CLIENT_SECRET ?? env.GITHUB_CLIENT_SECRET ?? '';
     const urlForKeys = 'https://github.com/settings/developers';
     checkOAuthConfig(name, clientID, secret, urlForKeys, false);
     return {
         name,
         isPKCE: false,
         getArcticProvider: () => {
-            const redirectURI = options?.GITHUB_REDIRECT_URI || `${remult.context.url.origin}/api/auth_callback`;
+            const redirectURI = options?.GITHUB_REDIRECT_URI ??
+                env.GITHUB_REDIRECT_URI ??
+                `${remult.context.url.origin}/api/auth_callback`;
             checkOAuthConfig(name, clientID, secret, urlForKeys, true);
             return new GitHub(clientID, secret, { redirectURI });
         },

package/esm/auth/providers/strava.d.ts

@@ -1,25 +1,30 @@
 import { Strava } from 'arctic';
-import { type KitOAuth2Provider } from '../';
+import { type FFOAuth2Provider } from '../';
 /**
- * Strava OAuth2 provider
+ * ## Strava OAuth2 provider
  *
- * In Strava, set your callback url to
- * - dev: `http://localhost:5173/api/auth_callback`
- * - prod: `https://MY_SUPER_SITE/api/auth_callback`
- *
- * In your project add a `.env` file with the following:
- *
- * ```env
- * STRAVA_CLIENT_ID= 'your-client-id'
- * STRAVA_CLIENT_SECRET= 'your-client-secret'
+ * 1. Get your **id** & **secret** from [Strava (direct link)](https://www.strava.com/settings/api).
+ * 2. In Strava, set your callback url to
+ * - [ ] dev: `http://localhost:5173/api/auth_callback`
+ * - [ ] prod: `https://MY_SUPER_SITE/api/auth_callback`
+ * 3. In your project add a `.env` file with the following:
+ * ```bash
+ * STRAVA_CLIENT_ID = 'your-client-id'
+ * STRAVA_CLIENT_SECRET = 'your-client-secret'
+ * # STRAVA_REDIRECT_URI = '' # optional, will default to "${origin}/api/auth_callback"
  * ```
- *
- * _FYI: STRAVA_REDIRECT_URI is optional as auth module will default to "${origin}/api/auth_callback"._
+ * 4. In your frontend, under a button click call something like:
+ * ```ts
+ * async function oauth() {
+ *   window.location.href = await Auth.signInOAuthGetUrl({ provider: 'strava', redirect: window.location.pathname })
+ * }
+ * ```
+ * 5. Enjoy 🥳
  */
 export declare function strava(options?: {
-    STRAVA_CLIENT_ID: string;
-    STRAVA_CLIENT_SECRET: string;
+    STRAVA_CLIENT_ID?: string;
+    STRAVA_CLIENT_SECRET?: string;
     STRAVA_REDIRECT_URI?: string;
-    authorizationURLOptions?: ReturnType<KitOAuth2Provider<'strava', Strava>['authorizationURLOptions']>;
+    authorizationURLOptions?: ReturnType<FFOAuth2Provider<'strava', Strava>['authorizationURLOptions']>;
     log?: boolean;
-}): KitOAuth2Provider<'strava', Strava>;
+}): FFOAuth2Provider<'strava', Strava>;

package/esm/auth/providers/strava.js

@@ -1,34 +1,42 @@
 import { Strava } from 'arctic';
 import { remult } from 'remult';
+import { env } from '$env/dynamic/private';
 import { checkOAuthConfig } from '.';
 import { logAuth } from '../';
 /**
- * Strava OAuth2 provider
+ * ## Strava OAuth2 provider
  *
- * In Strava, set your callback url to
- * - dev: `http://localhost:5173/api/auth_callback`
- * - prod: `https://MY_SUPER_SITE/api/auth_callback`
- *
- * In your project add a `.env` file with the following:
- *
- * ```env
- * STRAVA_CLIENT_ID= 'your-client-id'
- * STRAVA_CLIENT_SECRET= 'your-client-secret'
+ * 1. Get your **id** & **secret** from [Strava (direct link)](https://www.strava.com/settings/api).
+ * 2. In Strava, set your callback url to
+ * - [ ] dev: `http://localhost:5173/api/auth_callback`
+ * - [ ] prod: `https://MY_SUPER_SITE/api/auth_callback`
+ * 3. In your project add a `.env` file with the following:
+ * ```bash
+ * STRAVA_CLIENT_ID = 'your-client-id'
+ * STRAVA_CLIENT_SECRET = 'your-client-secret'
+ * # STRAVA_REDIRECT_URI = '' # optional, will default to "${origin}/api/auth_callback"
  * ```
- *
- * _FYI: STRAVA_REDIRECT_URI is optional as auth module will default to "${origin}/api/auth_callback"._
+ * 4. In your frontend, under a button click call something like:
+ * ```ts
+ * async function oauth() {
+ *   window.location.href = await Auth.signInOAuthGetUrl({ provider: 'strava', redirect: window.location.pathname })
+ * }
+ * ```
+ * 5. Enjoy 🥳
  */
 export function strava(options) {
     const name = 'strava';
-    const clientID = options?.STRAVA_CLIENT_ID ?? '';
-    const secret = options?.STRAVA_CLIENT_SECRET ?? '';
+    const clientID = options?.STRAVA_CLIENT_ID ?? env.STRAVA_CLIENT_ID ?? '';
+    const secret = options?.STRAVA_CLIENT_SECRET ?? env.STRAVA_CLIENT_SECRET ?? '';
     const urlForKeys = 'https://www.strava.com/settings/api';
     checkOAuthConfig(name, clientID, secret, urlForKeys, false);
     return {
         name,
         isPKCE: false,
         getArcticProvider: () => {
-            const redirectURI = options?.STRAVA_REDIRECT_URI || `${remult.context.url.origin}/api/auth_callback`;
+            const redirectURI = options?.STRAVA_REDIRECT_URI ??
+                env.STRAVA_REDIRECT_URI ??
+                `${remult.context.url.origin}/api/auth_callback`;
             checkOAuthConfig(name, clientID, secret, urlForKeys, true);
             return new Strava(clientID, secret, redirectURI);
         },

package/esm/auth/static/assets/Page-ByIhtXVt.d.ts

@@ -2,4 +2,4 @@ export { oo as default };
 declare class oo extends Je {
     constructor(e: any);
 }
-import { S as Je } from "./index-czJ1PA1n.js";
+import { S as Je } from './index-czJ1PA1n.js';