community-jazz-vue 0.15.4

package/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright 2025, Garden Computing, Inc.
+
+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/README.md

@@ -0,0 +1,26 @@
+# `community-jazz-vue`
+
+Vue bindings for Jazz (see [jazz.tools](https://jazz.tools)), a framework for distributed state.
+
+## Quick Start
+
+### 1. Install
+```bash
+npm install community-jazz-vue
+```
+
+### 2. Use Jazz Inspector
+```vue
+<template>
+  <JazzInspector position="bottom-right" />
+</template>
+
+<script setup>
+import { JazzInspector } from 'community-jazz-vue/inspector'
+</script>
+```
+
+## Documentation
+
+- [Inspector Documentation](./src/inspector/README.md)
+- [Canonical Vue Implementation](./src/inspector/CANONICAL_VUE_IMPLEMENTATION.md)

package/dist/Image.vue.d.ts

@@ -0,0 +1,26 @@
+export interface ImageProps {
+    /** The ID of the ImageDefinition to display */
+    imageId: string;
+    /**
+     * The desired width of the image. Can be a number in pixels or "original" to use the image's original width.
+     * When set to a number, the component will select the best available resolution and maintain aspect ratio.
+     */
+    width?: number | "original";
+    /**
+     * The desired height of the image. Can be a number in pixels or "original" to use the image's original height.
+     * When set to a number, the component will select the best available resolution and maintain aspect ratio.
+     */
+    height?: number | "original";
+    /** Alt text for the image */
+    alt?: string;
+    /** CSS classes to apply to the image */
+    classNames?: string;
+    /** CSS styles to apply to the image */
+    style?: string | Record<string, string>;
+    /** Loading strategy for the image */
+    loading?: "lazy" | "eager";
+}
+declare const _default: import('vue').DefineComponent<ImageProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<ImageProps> & Readonly<{}>, {
+    loading: "lazy" | "eager";
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLImageElement>;
+export default _default;

package/dist/auth/JazzVueProviderWithClerk.d.ts

@@ -0,0 +1,83 @@
+import { Account, AccountClass, AnyAccountSchema, CoValueFromRaw, SyncConfig, MinimalClerkClient } from 'jazz-tools';
+import { PropType } from 'vue';
+export declare const JazzVueProviderWithClerk: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    clerk: {
+        type: PropType<MinimalClerkClient>;
+        required: true;
+    };
+    AccountSchema: {
+        type: PropType<(AccountClass<Account> & CoValueFromRaw<Account>) | AnyAccountSchema>;
+        required: false;
+    };
+    guestMode: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    sync: {
+        type: PropType<SyncConfig>;
+        required: true;
+    };
+    storage: {
+        type: PropType<"indexedDB">;
+        default: undefined;
+    };
+    defaultProfileName: {
+        type: StringConstructor;
+        required: false;
+    };
+    onLogOut: {
+        type: PropType<() => void>;
+        required: false;
+    };
+    onAnonymousAccountDiscarded: {
+        type: PropType<(anonymousAccount: any) => Promise<void>>;
+        required: false;
+    };
+    enableSSR: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
+    [key: string]: any;
+}> | null, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    clerk: {
+        type: PropType<MinimalClerkClient>;
+        required: true;
+    };
+    AccountSchema: {
+        type: PropType<(AccountClass<Account> & CoValueFromRaw<Account>) | AnyAccountSchema>;
+        required: false;
+    };
+    guestMode: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    sync: {
+        type: PropType<SyncConfig>;
+        required: true;
+    };
+    storage: {
+        type: PropType<"indexedDB">;
+        default: undefined;
+    };
+    defaultProfileName: {
+        type: StringConstructor;
+        required: false;
+    };
+    onLogOut: {
+        type: PropType<() => void>;
+        required: false;
+    };
+    onAnonymousAccountDiscarded: {
+        type: PropType<(anonymousAccount: any) => Promise<void>>;
+        required: false;
+    };
+    enableSSR: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{}>, {
+    guestMode: boolean;
+    storage: "indexedDB";
+    enableSSR: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;

package/dist/auth/PasskeyAuthBasicUI.vue.d.ts

@@ -0,0 +1,21 @@
+interface Props {
+    appName: string;
+    appHostname?: string;
+}
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        default?(_: {}): any;
+    };
+    refs: {};
+    rootEl: any;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/auth/useClerkAuth.d.ts

@@ -0,0 +1,2 @@
+import { JazzClerkAuth, MinimalClerkClient } from 'jazz-tools';
+export declare function useClerkAuth(clerk: MinimalClerkClient): import('vue').Raw<JazzClerkAuth>;

package/dist/auth/useIsAuthenticated.d.ts

@@ -0,0 +1 @@
+export declare function useIsAuthenticated(): import('vue').Ref<boolean, boolean>;

package/dist/auth/usePasskeyAuth.d.ts

@@ -0,0 +1,18 @@
+/**
+ * `usePasskeyAuth` composable provides a `JazzAuth` object for passkey authentication.
+ *
+ * @example
+ * ```ts
+ * const auth = usePasskeyAuth({ appName, appHostname });
+ * ```
+ *
+ * @category Auth Providers
+ */
+export declare function usePasskeyAuth({ appName, appHostname, }: {
+    appName: string;
+    appHostname?: string;
+}): import('vue').ComputedRef<{
+    state: string;
+    logIn: () => Promise<void>;
+    signUp: (username: string) => Promise<void>;
+}>;

package/dist/auth/usePassphraseAuth.d.ts

@@ -0,0 +1,20 @@
+/**
+ * `usePassphraseAuth` composable provides a `JazzAuth` object for passphrase authentication.
+ *
+ * @example
+ * ```ts
+ * const auth = usePassphraseAuth({ wordlist });
+ * ```
+ *
+ * @category Auth Providers
+ */
+export declare function usePassphraseAuth({ wordlist }: {
+    wordlist: string[];
+}): import('vue').ComputedRef<{
+    state: string;
+    logIn: (passphrase: string) => Promise<void>;
+    signUp: (name?: string) => Promise<string>;
+    registerNewAccount: (passphrase: string, name: string) => Promise<string>;
+    generateRandomPassphrase: () => string;
+    passphrase: string;
+}>;

package/dist/composables.d.ts

@@ -0,0 +1,22 @@
+import { Account, AccountClass, AnonymousJazzAgent, AnyAccountSchema, AuthSecretStorage, CoValue, CoValueClassOrSchema, JazzContextManager, JazzContextType, Loaded, RefsToResolve, ResolveQuery, ResolveQueryStrict } from 'jazz-tools';
+import { ComputedRef, Ref } from 'vue';
+export declare const logoutHandler: Ref<(() => void) | undefined, (() => void) | undefined>;
+export declare function useJazzContext<Acc extends Account>(): Ref<JazzContextType<Acc>, JazzContextType<Acc>>;
+export declare function useJazzContextManager<Acc extends Account>(): Ref<JazzContextManager<Acc, {}>, JazzContextManager<Acc, {}>>;
+export declare function useAuthSecretStorage(): AuthSecretStorage;
+export declare function useAccount<A extends AccountClass<Account> | AnyAccountSchema = typeof Account, R extends ResolveQuery<A> = true>(AccountSchema?: A, options?: {
+    resolve?: ResolveQueryStrict<A, R>;
+}): {
+    me: ComputedRef<Loaded<A, R> | undefined | null>;
+    agent: AnonymousJazzAgent | Loaded<A, true>;
+    logOut: () => void;
+};
+export declare function useCoState<S extends CoValueClassOrSchema, const R extends RefsToResolve<S> = true>(Schema: S, id: string | undefined, options?: {
+    resolve?: ResolveQueryStrict<S, R>;
+}): Ref<Loaded<S, R> | undefined | null>;
+export declare function useAcceptInvite<S extends CoValueClassOrSchema>({ invitedObjectSchema, onAccept, forValueHint, }: {
+    invitedObjectSchema: S;
+    onAccept: (projectID: string) => void;
+    forValueHint?: string;
+}): void;
+export declare function experimental_useInboxSender<I extends CoValue, O extends CoValue | undefined>(inboxOwnerID: string | undefined): (message: I) => Promise<O extends CoValue ? string : undefined>;

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+export * from './composables.js';
+export { JazzProvider, JazzVueProvider } from './provider.js';
+export * from './auth/usePassphraseAuth.js';
+export * from './auth/useIsAuthenticated.js';
+export * from './auth/usePasskeyAuth.js';
+export * from './auth/useClerkAuth.js';
+export { JazzVueProviderWithClerk } from './auth/JazzVueProviderWithClerk.js';
+export { default as PasskeyAuthBasicUI } from './auth/PasskeyAuthBasicUI.vue';
+export { default as Image } from './Image.vue';
+export { createInviteLink, parseInviteLink } from 'jazz-tools/browser';
+export { createImage } from 'jazz-tools/media';