@hellocoop/svelte 2.0.0 → 2.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Hellō
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/auth.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="svelte" />
 import type { Readable } from 'svelte/store';
 import type { Claims } from './types.js';
 type AuthCookie = {

package/dist/auth.js

@@ -1,6 +1,7 @@
 /// <reference types="svelte" />
 // @ts-ignore tbd
 import { useSWR } from "sswr";
+// @ts-ignore tbd - has no exported member?
 import { getHelloProviderContext, routeConfig } from "./Provider.svelte";
 const fetcher = async (url) => {
     try {

package/dist/buttons/BaseButton.svelte

@@ -1,6 +1,6 @@
 <script>import { routeConfig } from "../Provider.svelte";
 import { onMount } from "svelte";
-import { Button } from "../types.js";
+import { Button } from "@hellocoop/definitions";
 export let label = "\u014D&nbsp;&nbsp;&nbsp;Continue with Hell\u014D";
 export let style = {};
 export let color = "black";
@@ -12,6 +12,10 @@ export let targetURI = "";
 export let providerHint = [];
 export let showLoader = false;
 export let disabled = false;
+export let promptLogin = false;
+export let promptConsent = false;
+export let loginHint = "";
+export let domainHint = "";
 let checkedForStylesheet = false;
 onMount(() => {
   if (typeof window != "undefined" && !checkedForStylesheet) {
@@ -30,6 +34,17 @@ if (scope)
 loginRoute.searchParams.set("target_uri", targetURI || window.location.pathname);
 if (update)
   loginRoute.searchParams.set("prompt", "consent");
+if (promptLogin && promptConsent) {
+  loginRoute.searchParams.set("prompt", "login consent");
+} else if (promptLogin) {
+  loginRoute.searchParams.set("prompt", "login");
+} else if (promptConsent) {
+  loginRoute.searchParams.set("prompt", "consent");
+}
+if (loginHint)
+  loginRoute.searchParams.set("login_hint", loginHint);
+if (domainHint)
+  loginRoute.searchParams.set("login_hint", domainHint);
 if (providerHint)
   loginRoute.searchParams.set("provider_hint", providerHint.join(" "));
 const onClickHandler = () => {

package/dist/buttons/BaseButton.svelte.d.ts

@@ -1,17 +1,23 @@
 import { SvelteComponent } from "svelte";
+import type { ProviderHint, Scope } from '@hellocoop/definitions';
+import { Button } from '@hellocoop/definitions';
 declare const __propDef: {
     props: {
-        label?: string | undefined;
+        label?: string;
         style?: any;
-        color?: any;
-        theme?: any;
-        hover?: any;
-        scope?: ("name" | "nickname" | "preferred_username" | "given_name" | "family_name" | "email" | "phone" | "picture" | "ethereum" | "discord" | "twitter" | "github" | "gitlab" | "profile" | "openid" | "profile_update")[] | undefined;
-        update?: boolean | undefined;
-        targetURI?: string | undefined;
-        providerHint?: ("phone" | "ethereum" | "discord" | "twitter" | "github" | "gitlab" | "apple" | "facebook" | "google" | "twitch" | "tumblr" | "mastodon" | "microsoft" | "line" | "wordpress" | "yahoo" | "qrcode" | "apple--" | "microsoft--" | "google--" | "email--" | "passkey--")[] | undefined;
-        showLoader?: boolean | undefined;
-        disabled?: boolean | undefined;
+        color?: Button.Color;
+        theme?: Button.Theme;
+        hover?: Button.Hover;
+        scope?: Scope[];
+        update?: boolean;
+        targetURI?: string;
+        providerHint?: ProviderHint[];
+        showLoader?: boolean;
+        disabled?: boolean;
+        promptLogin?: boolean;
+        promptConsent?: boolean;
+        loginHint?: string;
+        domainHint?: string;
     };
     events: {
         [evt: string]: CustomEvent<any>;

package/dist/buttons/LoginButton.svelte

@@ -1,4 +1,4 @@
 <script>import BaseButton from "./BaseButton.svelte";
 </script>
 
-<BaseButton label="ō&nbsp;&nbsp;&nbsp;Login with Hellō" {...$$props} />
+<BaseButton {...$$props} label="ō&nbsp;&nbsp;&nbsp;Login with Hellō" />

package/dist/buttons/UpdateProfileButton.svelte

@@ -1,4 +1,4 @@
 <script>import BaseButton from "./BaseButton.svelte.js";
 </script>
 
-<BaseButton label="ō&nbsp;&nbsp;&nbsp;Update Profile with Hellō" {...$$props} update={true} />
+<BaseButton {...$$props} label="ō&nbsp;&nbsp;&nbsp;Update Profile with Hellō" update={true} />

package/dist/index.js

@@ -11,4 +11,5 @@ export * from './auth.js';
 //Logout
 export * from './logout.js';
 //Provider
+// @ts-ignore tbd - has no exported member?
 export { default as HelloProvider, routeConfig, getHelloProviderContext } from './Provider.svelte';

package/dist/logout.js

@@ -1,4 +1,5 @@
 /// <reference types="svelte" />
+// @ts-ignore tbd - has no exported member?
 import { routeConfig } from './Provider.svelte';
 export const getLogOutRoute = () => routeConfig.logout;
 export function logOut() {

package/dist/types.d.ts

@@ -1,35 +1,25 @@
-import { VALID_IDENTITY_STRING_CLAIMS, VALID_IDENTITY_ACCOUNT_CLAIMS, VALID_SCOPES, VALID_RESPONSE_TYPE, VALID_RESPONSE_MODE, VALID_PROVIDER_HINT } from '@hellocoop/constants';
+export declare const PRODUCTION_WALLET: string;
+export declare const DEFAULT_SCOPE: Scope[];
+export declare const DEFAULT_RESPONSE_TYPE: AuthResponseType;
+export declare const DEFAULT_RESPONSE_MODE: AuthResponseMode;
+export declare const DEFAULT_PATH: string;
+export declare const VALID_IDENTITY_CLAIMS: readonly ["name", "nickname", "preferred_username", "given_name", "family_name", "email", "phone", "picture", "ethereum", "discord", "twitter", "github", "gitlab"];
+export declare const VALID_SCOPES: readonly ["name", "nickname", "preferred_username", "given_name", "family_name", "email", "phone", "picture", "ethereum", "discord", "twitter", "github", "gitlab", "openid", "profile_update"];
+export declare const VALID_RESPONSE_TYPE: readonly ["id_token", "code"];
+export declare const VALID_RESPONSE_MODE: string[];
+export declare const VALID_PROVIDER_HINT: readonly ["apple", "discord", "facebook", "github", "gitlab", "google", "twitch", "twitter", "tumblr", "mastodon", "microsoft", "line", "wordpress", "yahoo", "phone", "ethereum", "qrcode", "apple--", "microsoft--", "google--", "email--", "passkey--"];
 export type Scope = typeof VALID_SCOPES[number];
 export type AuthResponseType = typeof VALID_RESPONSE_TYPE[number];
 export type AuthResponseMode = typeof VALID_RESPONSE_MODE[number];
 export type ProviderHint = typeof VALID_PROVIDER_HINT[number];
-type IdentityStringClaims = typeof VALID_IDENTITY_STRING_CLAIMS[number];
-type IdentityAccountClaims = typeof VALID_IDENTITY_ACCOUNT_CLAIMS[number];
-type OptionalStringClaims = {
-    [K in IdentityStringClaims]?: string;
+type IdentityClaims = typeof VALID_IDENTITY_CLAIMS[number];
+type OptionalClaims = {
+    [K in IdentityClaims]?: unknown;
 };
-type OptionalAccountClaims = {
-    [K in IdentityAccountClaims]?: {
-        id: string;
-        username: string;
-    };
-};
-export type Claims = OptionalStringClaims & OptionalAccountClaims & {
+export type Claims = OptionalClaims & {
     sub: string;
 };
-type AuthCookie = {
-    sub: string;
-    iat: number;
-} & Claims & {
-    [key: string]: any;
-};
-export type Auth = {
-    isLoggedIn: false;
-} | ({
-    isLoggedIn: true;
-    cookieToken?: string;
-} & AuthCookie);
-export type TokenPayload = OptionalStringClaims & OptionalAccountClaims & {
+export type TokenPayload = OptionalClaims & {
     iss: string;
     aud: string;
     nonce: string;
@@ -43,4 +33,31 @@ export type TokenHeader = {
     typ: string;
     alg: string;
 };
+export declare namespace Button {
+    type Color = "black" | "white";
+    type Theme = "ignore-light" | "ignore-dark" | "aware-invert" | "aware-static";
+    type Hover = "pop" | "glow" | "flare" | "none";
+    type Update = boolean;
+    const STYLES_URL = "https://cdn.hello.coop/css/hello-btn.css";
+    const HOVER_MAPPING: {
+        pop: string;
+        glow: string;
+        flare: string;
+        none: string;
+    };
+    const CLASS_MAPPING: {
+        black: {
+            "ignore-light": string;
+            "ignore-dark": string;
+            "aware-invert": string;
+            "aware-static": string;
+        };
+        white: {
+            "ignore-light": string;
+            "ignore-dark": string;
+            "aware-invert": string;
+            "aware-static": string;
+        };
+    };
+}
 export {};

package/dist/types.js

@@ -1,2 +1,95 @@
-// Hellō types
-import { VALID_IDENTITY_STRING_CLAIMS, VALID_IDENTITY_ACCOUNT_CLAIMS, VALID_SCOPES, VALID_RESPONSE_TYPE, VALID_RESPONSE_MODE, VALID_PROVIDER_HINT, } from '@hellocoop/constants';
+export const PRODUCTION_WALLET = 'https://wallet.hello.coop';
+export const DEFAULT_SCOPE = ['openid', 'name', 'email', 'picture'];
+export const DEFAULT_RESPONSE_TYPE = 'code';
+export const DEFAULT_RESPONSE_MODE = 'query';
+export const DEFAULT_PATH = '/authorize?';
+export const VALID_IDENTITY_CLAIMS = [
+    'name',
+    'nickname',
+    'preferred_username',
+    'given_name',
+    'family_name',
+    'email',
+    'phone',
+    'picture',
+    // Hellō extensions -- non-standard claims
+    'ethereum',
+    'discord',
+    'twitter',
+    'github',
+    'gitlab'
+];
+export const VALID_SCOPES = [
+    ...VALID_IDENTITY_CLAIMS,
+    'openid',
+    // Hellō extensions -- non-standard scopes
+    'profile_update',
+];
+export const VALID_RESPONSE_TYPE = ['id_token', 'code']; // Default: 'code'
+export const VALID_RESPONSE_MODE = ['fragment', 'query', 'form_post']; // Default: 'query'
+export const VALID_PROVIDER_HINT = [
+    // 'google' and 'email' are always in default
+    // 'apple' added if on Apple OS
+    // 'microsoft' added if on Microsoft OS
+    'apple',
+    'discord',
+    'facebook',
+    'github',
+    'gitlab',
+    'google',
+    'twitch',
+    'twitter',
+    'tumblr',
+    'mastodon',
+    'microsoft',
+    'line',
+    'wordpress',
+    'yahoo',
+    'phone',
+    'ethereum',
+    'qrcode',
+    // the following will remove provider from recommended list
+    'apple--',
+    'microsoft--',
+    'google--',
+    'email--',
+    'passkey--',
+];
+const CLASS_MAPPING = {
+    black: {
+        "ignore-light": "",
+        "ignore-dark": "hello-btn-black-on-dark",
+        "aware-invert": "hello-btn-black-and-invert",
+        "aware-static": "hello-btn-black-and-static"
+    },
+    white: {
+        "ignore-light": "hello-btn-white-on-light",
+        "ignore-dark": "hello-btn-white-on-dark",
+        "aware-invert": "hello-btn-white-and-invert",
+        "aware-static": "hello-btn-white-and-static"
+    },
+};
+export var Button;
+(function (Button) {
+    Button.STYLES_URL = 'https://cdn.hello.coop/css/hello-btn.css';
+    Button.HOVER_MAPPING = {
+        "pop": "",
+        "glow": "hello-btn-hover-glow",
+        "flare": "hello-btn-hover-flare",
+        "none": "hello-btn-hover-none"
+    };
+    Button.CLASS_MAPPING = {
+        black: {
+            "ignore-light": "",
+            "ignore-dark": "hello-btn-black-on-dark",
+            "aware-invert": "hello-btn-black-and-invert",
+            "aware-static": "hello-btn-black-and-static"
+        },
+        white: {
+            "ignore-light": "hello-btn-white-on-light",
+            "ignore-dark": "hello-btn-white-on-dark",
+            "aware-invert": "hello-btn-white-and-invert",
+            "aware-static": "hello-btn-white-and-static"
+        },
+    };
+})(Button || (Button = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hellocoop/svelte",
-	"version": "2.0.0",
+	"version": "2.1.1",
 	"description": "Svelte SDK for Hellō https://hello.dev",
 	"repository": {
 		"type": "git",
@@ -8,7 +8,8 @@
 	},
 	"homepage": "https://www.hello.dev/docs/sdks/svelte",
 	"scripts": {
-		"build": "cp ../types/src/types.ts ./src/lib/ && svelte-kit sync && svelte-package && publint"
+		"build": "svelte-kit sync && svelte-package && publint",
+		"prebuild": "rimraf dist node_modules"
 	},
 	"exports": {
 		".": {
@@ -43,7 +44,7 @@
 		"svelte": "^4.0.0"
 	},
 	"devDependencies": {
-		"@sveltejs/adapter-auto": "^2.0.0",
+		"@sveltejs/adapter-auto": "^2.1.1",
 		"@sveltejs/kit": "^1.20.4",
 		"@sveltejs/package": "^2.0.0",
 		"publint": "^0.1.9",
@@ -57,6 +58,8 @@
 	"types": "./dist/index.d.ts",
 	"type": "module",
 	"dependencies": {
+		"@hellocoop/definitions": "^1.0.4",
 		"sswr": "^2.0.0"
-	}
+	},
+	"gitHead": "b418b4e249a7fe7025d467688e52132848b465a2"
 }