@dropby/vue 0.4.0

package/dist/index.d.ts

@@ -0,0 +1,123 @@
+import { t as PublicComponent } from "./chunks/public-component-A2rcQYAZ.js";
+import { ExtractPublicPropTypes, MaybeRefOrGetter, PropType, Ref, VNode } from "vue";
+import { AsksActions, AsksActions as AsksActions$1, AsyncResource, BootstrapState, CapabilityState, ChatActions, ChatActions as ChatActions$1, ChatHistoryLoadState, ChatThread, ChatThreadActions, ChatThreadActions as ChatThreadActions$1, ChatThreadsCollection, ChatUnread, ConnectionState, DropBy, DropById, DropByOptions, FlagValue, Idea, IdeasActions, IdeasActions as IdeasActions$1, IdeasState, PagedCollection, PendingAsksCollection, ResolvedFeatureConfig } from "@dropby/browser";
+/**
+ * The props `DropByProvider` takes: the `options` to create an instance from,
+ * or an instance of your own, not both.
+ */
+type DropByProviderProps = {
+  /** An instance you created; you start and destroy it. */
+  dropby: DropBy;
+  /** Pass `options` or `dropby`, not both. */
+  options?: undefined;
+} | {
+  /** Options for the instance the provider creates, starts and destroys. Read once. */
+  options: DropByOptions;
+  /** Pass `options` or `dropby`, not both. */
+  dropby?: undefined;
+};
+declare const dropByProviderProps: {
+  /** An instance you created; you start and destroy it. */
+  readonly dropby: {
+    readonly type: PropType<DropBy>;
+    readonly default: undefined;
+  };
+  /** Options for the instance the provider creates, starts and destroys. Read once. */
+  readonly options: {
+    readonly type: PropType<DropByOptions>;
+    readonly default: undefined;
+  };
+};
+interface DropByProviderSlots {
+  /** The part of your app that uses DropBy. */
+  default?: () => VNode[];
+}
+/**
+ * Makes a DropBy instance available to the composables and components below it.
+ * With `options` it creates the instance, starts it once mounted and destroys it
+ * with its scope; give it a `:key` of the signed-in user's and account's ids so
+ * a new identity gets a new instance. With `dropby` it only provides yours.
+ */
+export declare const DropByProvider: PublicComponent<ExtractPublicPropTypes<typeof dropByProviderProps>, DropByProviderSlots>;
+/** The DropBy instance from the nearest `DropByProvider`. Throws outside one. */
+export declare function useDropBy(): DropBy;
+/** The instance's live state, from `useDropByState`. */
+interface UseDropByStateResult {
+  /** How live updates arrive. */
+  connection: Readonly<Ref<ConnectionState>>;
+  /** What the session may do, with your team's widget settings applied. */
+  capabilities: Readonly<Ref<CapabilityState>>;
+  /** The signed-in session, with its feature flags. */
+  bootstrap: Readonly<Ref<BootstrapState>>;
+}
+/** The instance's connection, capabilities and session, each a read-only ref. */
+export declare function useDropByState(): UseDropByStateResult;
+/** What `useChatThreads` returns. */
+interface UseChatThreadsResult {
+  /** The conversation list, as a read-only ref. */
+  data: Readonly<Ref<ChatThreadsCollection>>;
+  /** Chat's actions; the same object for the component's life. */
+  actions: ChatActions$1;
+}
+/** The conversation list and chat's actions. Load it with `actions.listThreads()`. */
+export declare function useChatThreads(): UseChatThreadsResult;
+/** What `useChatThread` returns. */
+interface UseChatThreadResult {
+  /** The load of older messages, once one started. */
+  olderMessages: Readonly<Ref<ChatHistoryLoadState | undefined>>;
+  /** The load of the newest messages, once one started. */
+  latestMessages: Readonly<Ref<ChatHistoryLoadState | undefined>>;
+  /** The conversation as loaded, as a read-only ref. */
+  data: Readonly<Ref<AsyncResource<ChatThread> | undefined>>;
+  /** The conversation's actions, its id bound. */
+  actions: ChatThreadActions$1;
+}
+/**
+ * One conversation and its actions. Load it with `actions.open()`; its live
+ * updates are applied while the component is mounted. The id may be a ref or a
+ * getter, and everything follows it when it changes.
+ */
+export declare function useChatThread(id: MaybeRefOrGetter<DropById<"thr_">>): UseChatThreadResult;
+/**
+ * Unread replies across the user's conversations, and chat's actions. Load with
+ * `actions.refreshUnread()`.
+ */
+export declare function useChatUnread(): {
+  data: Readonly<Ref<AsyncResource<ChatUnread>>>;
+  actions: ChatActions$1;
+};
+/** What `useIdeas` returns. */
+interface UseIdeasResult<Data = PagedCollection<Idea>> {
+  /** The ideas list, or what your selector picked, as a read-only ref. */
+  data: Readonly<Ref<Data>>;
+  /** The board's actions; the same object for the component's life. */
+  actions: IdeasActions$1;
+}
+/**
+ * The ideas list and the board's actions. It loads nothing itself: list with
+ * `actions.list({ view })`. Pass a selector to read another part of the board's
+ * state, such as the idea opened.
+ */
+export declare function useIdeas(): UseIdeasResult;
+export declare function useIdeas<Selected>(selector: (state: IdeasState) => Selected, isEqual?: (a: Selected, b: Selected) => boolean): UseIdeasResult<Selected>;
+/** What `usePendingAsks` returns. */
+interface UsePendingAsksResult {
+  /** The asks waiting for the user, as a read-only ref. */
+  data: Readonly<Ref<PendingAsksCollection>>;
+  /** The asks' actions; the same object for the component's life. */
+  actions: AsksActions$1;
+}
+/** The asks waiting for the user, and their actions. Load them with `actions.listPending()`. */
+export declare function usePendingAsks(): UsePendingAsksResult;
+/**
+ * Every feature flag for the signed-in user, as a read-only ref; empty until the
+ * session has loaded.
+ */
+export declare function useFeatureConfig(): Readonly<Ref<ResolvedFeatureConfig>>;
+/**
+ * One feature flag's value, as a read-only ref that changes only with it;
+ * undefined for a flag that does not exist or until the session has loaded. The
+ * name may be a ref or a getter.
+ */
+export declare function useFeatureFlag(key: MaybeRefOrGetter<string>): Readonly<Ref<FlagValue | undefined>>;
+export type { AsksActions, ChatActions, ChatThreadActions, DropByProviderProps, IdeasActions, UseChatThreadResult, UseChatThreadsResult, UseDropByStateResult, UseIdeasResult, UsePendingAsksResult };

package/dist/index.js

@@ -0,0 +1,33 @@
+import { i as dropByKey, n as useDropByState, t as useDropBy } from "./chunks/use-drop-by-4B6MMMx1.js";
+import { a as useChatThread, i as useIdeas, n as useFeatureFlag, o as useChatThreads, r as usePendingAsks, s as useChatUnread, t as useFeatureConfig } from "./chunks/use-feature-BQHA7pdn.js";
+import { defineComponent, markRaw, onMounted, onScopeDispose, provide, toRaw } from "vue";
+import { createDropBy } from "@dropby/browser";
+const DropByProvider = defineComponent({
+	name: "DropByProvider",
+	slots: Object,
+	props: {
+		dropby: {
+			type: Object,
+			default: void 0
+		},
+		options: {
+			type: Object,
+			default: void 0
+		}
+	},
+	setup(props, { slots }) {
+		provide(dropByKey, resolveCore(props));
+		return () => slots.default?.();
+	}
+});
+function resolveCore(props) {
+	if (props.dropby) return toRaw(props.dropby);
+	if (props.options) {
+		const core = markRaw(createDropBy(props.options));
+		onMounted(() => core.start());
+		onScopeDispose(() => core.destroy());
+		return core;
+	}
+	throw new Error("DropByProvider requires either a `dropby` or an `options` prop.");
+}
+export { DropByProvider, useChatThread, useChatThreads, useChatUnread, useDropBy, useDropByState, useFeatureConfig, useFeatureFlag, useIdeas, usePendingAsks };

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@dropby/vue",
+  "version": "0.4.0",
+  "private": false,
+  "description": "Vue bindings for DropBy: a provider, composables and components for chat, ideas and asks.",
+  "keywords": [
+    "dropby",
+    "vue",
+    "customer-support",
+    "chat",
+    "feedback",
+    "feature-requests",
+    "surveys",
+    "sdk"
+  ],
+  "license": "MIT",
+  "author": "Simpllyf Software",
+  "homepage": "https://dropby.chat",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./components": {
+      "types": "./dist/components/index.d.ts",
+      "import": "./dist/components/index.js",
+      "default": "./dist/components/index.js"
+    },
+    "./components/chat-attachments": {
+      "types": "./dist/components/chat-attachments/index.d.ts",
+      "import": "./dist/components/chat-attachments/index.js",
+      "default": "./dist/components/chat-attachments/index.js"
+    }
+  },
+  "peerDependencies": {
+    "vue": "^3.4"
+  },
+  "dependencies": {
+    "@dropby/browser": "0.4.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "714b80e34a96081832e3c6e66ede69b925c9b851",
+  "types": "./dist/index.d.ts",
+  "main": "./dist/index.js"
+}