@basestack/flags-wc 0.0.1

package/dist/types/components.d.ts

@@ -0,0 +1,472 @@
+/* eslint-disable */
+/* tslint:disable */
+/**
+ * This is an autogenerated file created by the Stencil compiler.
+ * It contains typing information for all components that exist in this project.
+ */
+import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
+import { FeedbackPayload } from "./components/feature-flag-feedback-modal/feature-flag-feedback-modal";
+import { FlagSelectionPayload } from "./lib/feature-flags";
+export { FeedbackPayload } from "./components/feature-flag-feedback-modal/feature-flag-feedback-modal";
+export { FlagSelectionPayload } from "./lib/feature-flags";
+export namespace Components {
+    interface FeatureFlagFeedbackModal {
+        /**
+          * Endpoint used to POST feedback. Defaults to the Basestack feedback API.
+          * @default DEFAULT_FEEDBACK_ENDPOINT
+         */
+        "apiEndpoint": string;
+        /**
+          * Label for the close controls.
+          * @default "Close"
+         */
+        "closeLabel": string;
+        /**
+          * Environment key header (x-environment-key).
+         */
+        "environmentKey"?: string;
+        /**
+          * Human-friendly name of the feature to display in the UI.
+         */
+        "featureName"?: string;
+        /**
+          * Label above the textarea input.
+          * @default "Share your feedback"
+         */
+        "feedbackLabel": string;
+        /**
+          * Placeholder text inside the textarea input.
+          * @default "Anything else you’d like to add?"
+         */
+        "feedbackPlaceholder": string;
+        /**
+          * The Basestack flag key this feedback is for.
+         */
+        "flagKey": string;
+        /**
+          * Dialog heading text.
+          * @default "Feedback"
+         */
+        "heading": string;
+        /**
+          * Label above the mood selector.
+          * @default "How are you feeling after using this feature?"
+         */
+        "moodPrompt": string;
+        /**
+          * Controls dialog visibility.
+          * @default false
+         */
+        "open": boolean;
+        /**
+          * @default "To keep your data safe, avoid sharing personal or sensitive details."
+         */
+        "privacyPolicyLabel": string;
+        /**
+          * @default "Learn more"
+         */
+        "privacyPolicyLinkLabel": string;
+        /**
+          * @default "https://basestack.co/legal/privacy"
+         */
+        "privacyPolicyUrl": string;
+        /**
+          * Project key header (x-project-key).
+         */
+        "projectKey"?: string;
+        /**
+          * Label above the rating selector.
+          * @default "How satisfied are you with this feature?"
+         */
+        "ratingPrompt": string;
+        /**
+          * Label for the submit button.
+          * @default "Submit feedback"
+         */
+        "submitLabel": string;
+        /**
+          * @default "light"
+         */
+        "theme": "light" | "dark";
+    }
+    interface FeatureFlagPreviewModal {
+        /**
+          * Endpoint used to fetch feature flags. If omitted, defaults to the Basestack preview API.
+          * @default DEFAULT_FLAGS_ENDPOINT
+         */
+        "apiEndpoint": string;
+        /**
+          * Label for the close button and overlay.
+          * @default "Close"
+         */
+        "closeLabel": string;
+        /**
+          * Label shown when no previews are available.
+          * @default "No feature flags available at the moment."
+         */
+        "emptyLabel": string;
+        /**
+          * Label for the primary enable button when a flag is disabled.
+          * @default "Enable"
+         */
+        "enableLabel": string;
+        /**
+          * Label for the primary enable button when a flag is enabled.
+          * @default "Disable"
+         */
+        "enabledLabel": string;
+        /**
+          * Environment key header (x-environment-key).
+         */
+        "environmentKey"?: string;
+        /**
+          * Label for the expiration badge.
+          * @default "Expires soon"
+         */
+        "expiresSoonLabel": string;
+        /**
+          * Dialog title.
+          * @default "Feature preview"
+         */
+        "heading": string;
+        /**
+          * Label for the documentation link.
+          * @default "Learn more"
+         */
+        "learnMoreLabel": string;
+        /**
+          * Label shown when loading previews.
+          * @default "Loading features…"
+         */
+        "loadingLabel": string;
+        /**
+          * Controls dialog visibility.
+          * @default false
+         */
+        "open": boolean;
+        /**
+          * Label for the preview badge.
+          * @default "Preview"
+         */
+        "previewBadgeLabel": string;
+        /**
+          * Project key header (x-project-key).
+         */
+        "projectKey"?: string;
+        /**
+          * Placeholder text shown in the details panel when nothing is selected.
+          * @default "Select a feature on the left to see its details."
+         */
+        "selectionPlaceholder": string;
+        /**
+          * Title shown when nothing is selected.
+          * @default "Choose a feature to view"
+         */
+        "selectionPrompt": string;
+        /**
+          * When true, renders the close button.
+          * @default true
+         */
+        "showCloseButton": boolean;
+        /**
+          * Local storage key used to persist enabled flags.
+          * @default DEFAULT_STORAGE_KEY
+         */
+        "storageKey": string;
+        /**
+          * Optional supporting copy under the title.
+          * @default "Get early access to new features and let us know what you think."
+         */
+        "subtitle": string;
+        /**
+          * @default "light"
+         */
+        "theme": "light" | "dark";
+    }
+}
+export interface FeatureFlagFeedbackModalCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLFeatureFlagFeedbackModalElement;
+}
+export interface FeatureFlagPreviewModalCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLFeatureFlagPreviewModalElement;
+}
+declare global {
+    interface HTMLFeatureFlagFeedbackModalElementEventMap {
+        "feedbackSent": FeedbackPayload;
+        "closed": void;
+    }
+    interface HTMLFeatureFlagFeedbackModalElement extends Components.FeatureFlagFeedbackModal, HTMLStencilElement {
+        addEventListener<K extends keyof HTMLFeatureFlagFeedbackModalElementEventMap>(type: K, listener: (this: HTMLFeatureFlagFeedbackModalElement, ev: FeatureFlagFeedbackModalCustomEvent<HTMLFeatureFlagFeedbackModalElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLFeatureFlagFeedbackModalElementEventMap>(type: K, listener: (this: HTMLFeatureFlagFeedbackModalElement, ev: FeatureFlagFeedbackModalCustomEvent<HTMLFeatureFlagFeedbackModalElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+    }
+    var HTMLFeatureFlagFeedbackModalElement: {
+        prototype: HTMLFeatureFlagFeedbackModalElement;
+        new (): HTMLFeatureFlagFeedbackModalElement;
+    };
+    interface HTMLFeatureFlagPreviewModalElementEventMap {
+        "flagChange": FlagSelectionPayload;
+        "closed": void;
+    }
+    interface HTMLFeatureFlagPreviewModalElement extends Components.FeatureFlagPreviewModal, HTMLStencilElement {
+        addEventListener<K extends keyof HTMLFeatureFlagPreviewModalElementEventMap>(type: K, listener: (this: HTMLFeatureFlagPreviewModalElement, ev: FeatureFlagPreviewModalCustomEvent<HTMLFeatureFlagPreviewModalElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLFeatureFlagPreviewModalElementEventMap>(type: K, listener: (this: HTMLFeatureFlagPreviewModalElement, ev: FeatureFlagPreviewModalCustomEvent<HTMLFeatureFlagPreviewModalElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+    }
+    var HTMLFeatureFlagPreviewModalElement: {
+        prototype: HTMLFeatureFlagPreviewModalElement;
+        new (): HTMLFeatureFlagPreviewModalElement;
+    };
+    interface HTMLElementTagNameMap {
+        "feature-flag-feedback-modal": HTMLFeatureFlagFeedbackModalElement;
+        "feature-flag-preview-modal": HTMLFeatureFlagPreviewModalElement;
+    }
+}
+declare namespace LocalJSX {
+    type OneOf<K extends string, PropT, AttrT = PropT> = { [P in K]: PropT } & { [P in `attr:${K}` | `prop:${K}`]?: never } | { [P in `attr:${K}`]: AttrT } & { [P in K | `prop:${K}`]?: never } | { [P in `prop:${K}`]: PropT } & { [P in K | `attr:${K}`]?: never };
+
+    interface FeatureFlagFeedbackModal {
+        /**
+          * Endpoint used to POST feedback. Defaults to the Basestack feedback API.
+          * @default DEFAULT_FEEDBACK_ENDPOINT
+         */
+        "apiEndpoint"?: string;
+        /**
+          * Label for the close controls.
+          * @default "Close"
+         */
+        "closeLabel"?: string;
+        /**
+          * Environment key header (x-environment-key).
+         */
+        "environmentKey"?: string;
+        /**
+          * Human-friendly name of the feature to display in the UI.
+         */
+        "featureName"?: string;
+        /**
+          * Label above the textarea input.
+          * @default "Share your feedback"
+         */
+        "feedbackLabel"?: string;
+        /**
+          * Placeholder text inside the textarea input.
+          * @default "Anything else you’d like to add?"
+         */
+        "feedbackPlaceholder"?: string;
+        /**
+          * The Basestack flag key this feedback is for.
+         */
+        "flagKey": string;
+        /**
+          * Dialog heading text.
+          * @default "Feedback"
+         */
+        "heading"?: string;
+        /**
+          * Label above the mood selector.
+          * @default "How are you feeling after using this feature?"
+         */
+        "moodPrompt"?: string;
+        "onClosed"?: (event: FeatureFlagFeedbackModalCustomEvent<void>) => void;
+        "onFeedbackSent"?: (event: FeatureFlagFeedbackModalCustomEvent<FeedbackPayload>) => void;
+        /**
+          * Controls dialog visibility.
+          * @default false
+         */
+        "open"?: boolean;
+        /**
+          * @default "To keep your data safe, avoid sharing personal or sensitive details."
+         */
+        "privacyPolicyLabel"?: string;
+        /**
+          * @default "Learn more"
+         */
+        "privacyPolicyLinkLabel"?: string;
+        /**
+          * @default "https://basestack.co/legal/privacy"
+         */
+        "privacyPolicyUrl"?: string;
+        /**
+          * Project key header (x-project-key).
+         */
+        "projectKey"?: string;
+        /**
+          * Label above the rating selector.
+          * @default "How satisfied are you with this feature?"
+         */
+        "ratingPrompt"?: string;
+        /**
+          * Label for the submit button.
+          * @default "Submit feedback"
+         */
+        "submitLabel"?: string;
+        /**
+          * @default "light"
+         */
+        "theme"?: "light" | "dark";
+    }
+    interface FeatureFlagPreviewModal {
+        /**
+          * Endpoint used to fetch feature flags. If omitted, defaults to the Basestack preview API.
+          * @default DEFAULT_FLAGS_ENDPOINT
+         */
+        "apiEndpoint"?: string;
+        /**
+          * Label for the close button and overlay.
+          * @default "Close"
+         */
+        "closeLabel"?: string;
+        /**
+          * Label shown when no previews are available.
+          * @default "No feature flags available at the moment."
+         */
+        "emptyLabel"?: string;
+        /**
+          * Label for the primary enable button when a flag is disabled.
+          * @default "Enable"
+         */
+        "enableLabel"?: string;
+        /**
+          * Label for the primary enable button when a flag is enabled.
+          * @default "Disable"
+         */
+        "enabledLabel"?: string;
+        /**
+          * Environment key header (x-environment-key).
+         */
+        "environmentKey"?: string;
+        /**
+          * Label for the expiration badge.
+          * @default "Expires soon"
+         */
+        "expiresSoonLabel"?: string;
+        /**
+          * Dialog title.
+          * @default "Feature preview"
+         */
+        "heading"?: string;
+        /**
+          * Label for the documentation link.
+          * @default "Learn more"
+         */
+        "learnMoreLabel"?: string;
+        /**
+          * Label shown when loading previews.
+          * @default "Loading features…"
+         */
+        "loadingLabel"?: string;
+        "onClosed"?: (event: FeatureFlagPreviewModalCustomEvent<void>) => void;
+        "onFlagChange"?: (event: FeatureFlagPreviewModalCustomEvent<FlagSelectionPayload>) => void;
+        /**
+          * Controls dialog visibility.
+          * @default false
+         */
+        "open"?: boolean;
+        /**
+          * Label for the preview badge.
+          * @default "Preview"
+         */
+        "previewBadgeLabel"?: string;
+        /**
+          * Project key header (x-project-key).
+         */
+        "projectKey"?: string;
+        /**
+          * Placeholder text shown in the details panel when nothing is selected.
+          * @default "Select a feature on the left to see its details."
+         */
+        "selectionPlaceholder"?: string;
+        /**
+          * Title shown when nothing is selected.
+          * @default "Choose a feature to view"
+         */
+        "selectionPrompt"?: string;
+        /**
+          * When true, renders the close button.
+          * @default true
+         */
+        "showCloseButton"?: boolean;
+        /**
+          * Local storage key used to persist enabled flags.
+          * @default DEFAULT_STORAGE_KEY
+         */
+        "storageKey"?: string;
+        /**
+          * Optional supporting copy under the title.
+          * @default "Get early access to new features and let us know what you think."
+         */
+        "subtitle"?: string;
+        /**
+          * @default "light"
+         */
+        "theme"?: "light" | "dark";
+    }
+
+    interface FeatureFlagFeedbackModalAttributes {
+        "theme": "light" | "dark";
+        "flagKey": string;
+        "featureName": string;
+        "projectKey": string;
+        "environmentKey": string;
+        "apiEndpoint": string;
+        "open": boolean;
+        "heading": string;
+        "moodPrompt": string;
+        "ratingPrompt": string;
+        "feedbackLabel": string;
+        "feedbackPlaceholder": string;
+        "submitLabel": string;
+        "privacyPolicyUrl": string;
+        "privacyPolicyLabel": string;
+        "privacyPolicyLinkLabel": string;
+        "closeLabel": string;
+    }
+    interface FeatureFlagPreviewModalAttributes {
+        "theme": "light" | "dark";
+        "apiEndpoint": string;
+        "projectKey": string;
+        "environmentKey": string;
+        "storageKey": string;
+        "open": boolean;
+        "heading": string;
+        "subtitle": string;
+        "closeLabel": string;
+        "showCloseButton": boolean;
+        "loadingLabel": string;
+        "emptyLabel": string;
+        "selectionPrompt": string;
+        "selectionPlaceholder": string;
+        "enableLabel": string;
+        "enabledLabel": string;
+        "previewBadgeLabel": string;
+        "expiresSoonLabel": string;
+        "learnMoreLabel": string;
+    }
+
+    interface IntrinsicElements {
+        "feature-flag-feedback-modal": Omit<FeatureFlagFeedbackModal, keyof FeatureFlagFeedbackModalAttributes> & { [K in keyof FeatureFlagFeedbackModal & keyof FeatureFlagFeedbackModalAttributes]?: FeatureFlagFeedbackModal[K] } & { [K in keyof FeatureFlagFeedbackModal & keyof FeatureFlagFeedbackModalAttributes as `attr:${K}`]?: FeatureFlagFeedbackModalAttributes[K] } & { [K in keyof FeatureFlagFeedbackModal & keyof FeatureFlagFeedbackModalAttributes as `prop:${K}`]?: FeatureFlagFeedbackModal[K] } & OneOf<"flagKey", FeatureFlagFeedbackModal["flagKey"], FeatureFlagFeedbackModalAttributes["flagKey"]>;
+        "feature-flag-preview-modal": Omit<FeatureFlagPreviewModal, keyof FeatureFlagPreviewModalAttributes> & { [K in keyof FeatureFlagPreviewModal & keyof FeatureFlagPreviewModalAttributes]?: FeatureFlagPreviewModal[K] } & { [K in keyof FeatureFlagPreviewModal & keyof FeatureFlagPreviewModalAttributes as `attr:${K}`]?: FeatureFlagPreviewModalAttributes[K] } & { [K in keyof FeatureFlagPreviewModal & keyof FeatureFlagPreviewModalAttributes as `prop:${K}`]?: FeatureFlagPreviewModal[K] };
+    }
+}
+export { LocalJSX as JSX };
+declare module "@stencil/core" {
+    export namespace JSX {
+        interface IntrinsicElements {
+            "feature-flag-feedback-modal": LocalJSX.IntrinsicElements["feature-flag-feedback-modal"] & JSXBase.HTMLAttributes<HTMLFeatureFlagFeedbackModalElement>;
+            "feature-flag-preview-modal": LocalJSX.IntrinsicElements["feature-flag-preview-modal"] & JSXBase.HTMLAttributes<HTMLFeatureFlagPreviewModalElement>;
+        }
+    }
+}

package/dist/types/lib/feature-flags.d.ts

@@ -0,0 +1,29 @@
+export type FeatureFlagState = Record<string, boolean>;
+export interface FeatureFlag {
+    slug: string;
+    description: string;
+    enabled?: boolean;
+    expiredAt?: string | null;
+    name?: string;
+    previewImage?: string;
+    documentationLink?: string;
+    previewName?: string;
+    previewContent?: string;
+}
+export interface FetchFlagsOptions {
+    endpoint?: string;
+    projectKey?: string;
+    environmentKey?: string;
+    init?: RequestInit;
+}
+export interface FlagSelectionPayload {
+    slug: string;
+    enabled: boolean;
+    flag?: FeatureFlag;
+}
+export declare const DEFAULT_STORAGE_KEY = "bs-flags-preview-state";
+export declare const DEFAULT_FLAGS_ENDPOINT = "https://flags.basestack.co/api/v1/flags/preview";
+export declare function fetchFeatureFlags(options?: FetchFlagsOptions): Promise<FeatureFlag[]>;
+export declare const readSelectionState: (storageKey?: string) => FeatureFlagState;
+export declare const writeSelectionState: (state: FeatureFlagState, storageKey?: string) => void;
+export declare const toggleFlagState: (flagSlug: string, enabled: boolean, storageKey?: string) => FeatureFlagState;

package/dist/types/lib/feature-flags.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/sdk/index.d.ts

@@ -0,0 +1,16 @@
+import { DEFAULT_FLAGS_ENDPOINT, DEFAULT_STORAGE_KEY, type FeatureFlag, type FeatureFlagState, type FlagSelectionPayload, fetchFeatureFlags, readSelectionState, toggleFlagState, writeSelectionState } from "../lib/feature-flags";
+export declare const registerFeatureFlagComponents: () => Promise<void>;
+export declare class FeatureFlagClient {
+    private readonly endpoint?;
+    private readonly storageKey;
+    constructor(endpoint?: string | undefined, storageKey?: string);
+    listFlags(params?: {
+        projectKey?: string;
+        environmentKey?: string;
+    }): Promise<FeatureFlag[]>;
+    loadSelections(): FeatureFlagState;
+    setSelection(flagId: string, enabled: boolean): FeatureFlagState;
+    writeSelections(state: FeatureFlagState): void;
+}
+export type { FeatureFlag, FeatureFlagState, FlagSelectionPayload };
+export { DEFAULT_FLAGS_ENDPOINT, DEFAULT_STORAGE_KEY, fetchFeatureFlags, readSelectionState, toggleFlagState, writeSelectionState, };

package/dist/types/sdk/index.test.d.ts

@@ -0,0 +1 @@
+export {};