@chill-sharp/vue-client 1.1.12

package/dist/composables.js

@@ -0,0 +1,450 @@
+/*
+ * ChillSharp is a lightweight .NET library that sits on top of Entity Framework Core
+ * and turns an existing data model into a fully working REST API with almost no setup.
+ * Copyright (C) 2025 Andrea Piovesan
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+import { onScopeDispose, ref, shallowRef, watch, watchEffect } from "vue";
+import { CHILL_SHARP_VUE_CLIENT_VERSION } from "./version.js";
+import { useChillSharpClient } from "./plugin.js";
+export function useSchema(chillType, chillViewCode = "default", cultureName, update = false) {
+    const client = useChillSharpClient();
+    const data = ref(null);
+    const error = ref(null);
+    const isLoading = ref(true);
+    const load = async () => {
+        isLoading.value = true;
+        error.value = null;
+        try {
+            const response = await client.getSchema(readRef(chillType), readRef(chillViewCode), cultureName === undefined ? undefined : readRef(cultureName), readRef(update) ?? false);
+            data.value = response;
+            return response;
+        }
+        catch (err) {
+            error.value = err;
+            throw err;
+        }
+        finally {
+            isLoading.value = false;
+        }
+    };
+    watchEffect(() => {
+        void load();
+    });
+    return {
+        data,
+        error,
+        isLoading,
+        reload: load
+    };
+}
+export function useSchemaList(cultureName) {
+    const client = useChillSharpClient();
+    const data = ref(null);
+    const error = ref(null);
+    const isLoading = ref(true);
+    const load = async () => {
+        isLoading.value = true;
+        error.value = null;
+        try {
+            const response = await client.getSchemaList(cultureName === undefined ? undefined : readRef(cultureName));
+            data.value = response;
+            return response;
+        }
+        catch (err) {
+            error.value = err;
+            throw err;
+        }
+        finally {
+            isLoading.value = false;
+        }
+    };
+    watchEffect(() => {
+        void load();
+    });
+    return {
+        data,
+        error,
+        isLoading,
+        reload: load
+    };
+}
+export function useText(request) {
+    const client = useChillSharpClient();
+    const data = ref(null);
+    const error = ref(null);
+    const isLoading = ref(true);
+    const load = async () => {
+        isLoading.value = true;
+        error.value = null;
+        try {
+            const response = await client.getText(readRef(request));
+            data.value = response;
+            return response;
+        }
+        catch (err) {
+            error.value = err;
+            throw err;
+        }
+        finally {
+            isLoading.value = false;
+        }
+    };
+    watchEffect(() => {
+        void load();
+    });
+    return {
+        data,
+        error,
+        isLoading,
+        reload: load
+    };
+}
+export function useTexts(requests) {
+    const client = useChillSharpClient();
+    const data = ref(null);
+    const error = ref(null);
+    const isLoading = ref(true);
+    const load = async () => {
+        isLoading.value = true;
+        error.value = null;
+        try {
+            const response = await client.getTexts(readRef(requests));
+            data.value = response;
+            return response;
+        }
+        catch (err) {
+            error.value = err;
+            throw err;
+        }
+        finally {
+            isLoading.value = false;
+        }
+    };
+    watchEffect(() => {
+        void load();
+    });
+    return {
+        data,
+        error,
+        isLoading,
+        reload: load
+    };
+}
+export function useVersion() {
+    return CHILL_SHARP_VUE_CLIENT_VERSION;
+}
+export function useTest() {
+    const client = useChillSharpClient();
+    const data = ref(null);
+    const error = ref(null);
+    const isLoading = ref(true);
+    const load = async () => {
+        isLoading.value = true;
+        error.value = null;
+        try {
+            const response = await client.test();
+            data.value = response;
+            return response;
+        }
+        catch (err) {
+            error.value = err;
+            throw err;
+        }
+        finally {
+            isLoading.value = false;
+        }
+    };
+    watchEffect(() => {
+        void load();
+    });
+    return {
+        data,
+        error,
+        isLoading,
+        reload: load
+    };
+}
+export function useCurrentUserPreferences() {
+    const client = useChillSharpClient();
+    // ChillUserPreferences extends the recursive JsonObject type. Keep it shallow so Vue
+    // does not recursively unwrap that type while inferring the composable return value.
+    const data = shallowRef(null);
+    const error = ref(null);
+    const isLoading = ref(true);
+    const load = async () => {
+        isLoading.value = true;
+        error.value = null;
+        try {
+            const response = await client.getCurrentUserPreferences();
+            data.value = response;
+            return response;
+        }
+        catch (err) {
+            error.value = err;
+            throw err;
+        }
+        finally {
+            isLoading.value = false;
+        }
+    };
+    watchEffect(() => { void load(); });
+    return { data, error, isLoading, reload: load };
+}
+export function useQueryMutation() {
+    const client = useChillSharpClient();
+    const data = ref(null);
+    const error = ref(null);
+    const isLoading = ref(false);
+    const execute = async (...args) => {
+        const payload = args[0];
+        isLoading.value = true;
+        error.value = null;
+        try {
+            const response = await client.query(payload);
+            data.value = response;
+            return response;
+        }
+        catch (err) {
+            error.value = err;
+            throw err;
+        }
+        finally {
+            isLoading.value = false;
+        }
+    };
+    return {
+        data,
+        error,
+        isLoading,
+        execute,
+        reset: () => {
+            data.value = null;
+            error.value = null;
+            isLoading.value = false;
+        }
+    };
+}
+export function useLookupMutation() {
+    const client = useChillSharpClient();
+    const data = ref(null);
+    const error = ref(null);
+    const isLoading = ref(false);
+    const execute = async (...args) => {
+        const payload = args[0];
+        isLoading.value = true;
+        error.value = null;
+        try {
+            const response = await client.lookup(payload);
+            data.value = response;
+            return response;
+        }
+        catch (err) {
+            error.value = err;
+            throw err;
+        }
+        finally {
+            isLoading.value = false;
+        }
+    };
+    return {
+        data,
+        error,
+        isLoading,
+        execute,
+        reset: () => {
+            data.value = null;
+            error.value = null;
+            isLoading.value = false;
+        }
+    };
+}
+export function useAutocompleteMutation() {
+    const client = useChillSharpClient();
+    const data = ref(null);
+    const error = ref(null);
+    const isLoading = ref(false);
+    const execute = async (...args) => {
+        const payload = args[0];
+        isLoading.value = true;
+        error.value = null;
+        try {
+            const response = await client.autocomplete(payload);
+            data.value = response;
+            return response;
+        }
+        catch (err) {
+            error.value = err;
+            throw err;
+        }
+        finally {
+            isLoading.value = false;
+        }
+    };
+    return {
+        data,
+        error,
+        isLoading,
+        execute,
+        reset: () => {
+            data.value = null;
+            error.value = null;
+            isLoading.value = false;
+        }
+    };
+}
+export function useValidateMutation() {
+    const client = useChillSharpClient();
+    const data = ref(null);
+    const error = ref(null);
+    const isLoading = ref(false);
+    const execute = async (...args) => {
+        const payload = args[0];
+        isLoading.value = true;
+        error.value = null;
+        try {
+            const response = await client.validate(payload);
+            data.value = response;
+            return response;
+        }
+        catch (err) {
+            error.value = err;
+            throw err;
+        }
+        finally {
+            isLoading.value = false;
+        }
+    };
+    return {
+        data,
+        error,
+        isLoading,
+        execute,
+        reset: () => {
+            data.value = null;
+            error.value = null;
+            isLoading.value = false;
+        }
+    };
+}
+export function useEntityMutation(action) {
+    const client = useChillSharpClient();
+    const data = ref(null);
+    const error = ref(null);
+    const isLoading = ref(false);
+    const execute = async (...args) => {
+        const payload = args[0];
+        isLoading.value = true;
+        error.value = null;
+        try {
+            let response;
+            switch (action) {
+                case "find":
+                    response = await client.find(payload);
+                    break;
+                case "create":
+                    response = await client.create(payload);
+                    break;
+                case "update":
+                    response = await client.update(payload);
+                    break;
+                default:
+                    await client.delete(payload);
+                    response = null;
+                    break;
+            }
+            data.value = response;
+            return response;
+        }
+        catch (err) {
+            error.value = err;
+            throw err;
+        }
+        finally {
+            isLoading.value = false;
+        }
+    };
+    return {
+        data,
+        error,
+        isLoading,
+        execute,
+        reset: () => {
+            data.value = null;
+            error.value = null;
+            isLoading.value = false;
+        }
+    };
+}
+export function useEntityChanges(chillType, onChanges, guid) {
+    const client = useChillSharpClient();
+    const error = ref(null);
+    const isSubscribed = ref(false);
+    let subscription = null;
+    const release = async () => {
+        const currentSubscription = subscription;
+        subscription = null;
+        isSubscribed.value = false;
+        if (currentSubscription) {
+            await currentSubscription.unsubscribe();
+        }
+    };
+    watch([
+        () => readRef(chillType),
+        () => (guid === undefined ? null : (readRef(guid) ?? null)),
+        () => readRef(onChanges)
+    ], async ([nextChillType, nextGuid, nextOnChanges], _previousValue, onCleanup) => {
+        error.value = null;
+        await release();
+        let isActive = true;
+        onCleanup(() => {
+            isActive = false;
+            void release();
+        });
+        try {
+            const nextSubscription = await client.subscribeToEntityChanges(nextChillType, async (changes) => {
+                await nextOnChanges(changes);
+            }, nextGuid);
+            if (!isActive) {
+                await nextSubscription.unsubscribe();
+                return;
+            }
+            subscription = nextSubscription;
+            isSubscribed.value = true;
+        }
+        catch (err) {
+            if (isActive) {
+                error.value = err;
+                isSubscribed.value = false;
+            }
+        }
+    }, { immediate: true });
+    onScopeDispose(() => {
+        void release();
+    });
+    return {
+        error,
+        isSubscribed
+    };
+}
+function asReadonlyRef(value) {
+    return value;
+}
+function readRef(value) {
+    if (typeof value === "object" && value !== null && "value" in value) {
+        return value.value;
+    }
+    return value;
+}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export { createChillSharpClient, createChillSharpPlugin, useChillSharpClient } from "./plugin.js";
+export { useAutocompleteMutation, useCurrentUserPreferences, useEntityChanges, useEntityMutation, useQueryMutation, useSchema, useSchemaList, useTest, useText, useTexts, useValidateMutation, useVersion } from "./composables.js";
+export type { ChillSharpVueOptions } from "./plugin.js";
+export type { UseChillAsyncState, UseChillMutationState, UseChillSubscriptionState } from "./composables.js";
+export { API_BASE_PATH, ChillSharpClient, ChillSharpClientError, PermissionAction, PermissionEffect, PermissionScope } from "@chill-sharp/ts-client";
+export { CHILL_SHARP_VUE_CLIENT_VERSION } from "./version.js";
+export type { AuthPermissionRule, AuthPermissionRuleItem, AuthRoleDetailsResponse, AuthRoleListItem, AuthRolePermissions, AuthTokenResponse, AuthUserDetailsResponse, AuthUserListItem, ChillDtoEntity, ChillUserPreferences, ChillDtoEntityOptions, ChillDtoMenuItem, ChillDtoProperty, ChillDtoPropertySchema, ChillDtoQuery, ChillDtoSchema, ChillDtoSchemaRelation, ChillDtoSchemaRelationLabel, ChillDtoSchemaListItem, ChillAttachmentUploadFile, ChillAttachmentUploadOptions, ChillEntityChangeAction, ChillEntityChangeCallback, ChillEntityChangeNotification, ChillEntityChangeSubscription, ChillOrdering, ChillPagination, ChillSharpClientOptions, GetAuthPermissionsResponse, GetTextRequest, GetTextResponse, JsonObject, JsonPrimitive, JsonValue, RegisterAuthIdentityRequest, SetAuthRoleRequest, SetAuthUserRequest } from "@chill-sharp/ts-client";

package/dist/index.js

@@ -0,0 +1,22 @@
+/*
+ * ChillSharp is a lightweight .NET library that sits on top of Entity Framework Core
+ * and turns an existing data model into a fully working REST API with almost no setup.
+ * Copyright (C) 2025 Andrea Piovesan
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+export { createChillSharpClient, createChillSharpPlugin, useChillSharpClient } from "./plugin.js";
+export { useAutocompleteMutation, useCurrentUserPreferences, useEntityChanges, useEntityMutation, useQueryMutation, useSchema, useSchemaList, useTest, useText, useTexts, useValidateMutation, useVersion } from "./composables.js";
+export { API_BASE_PATH, ChillSharpClient, ChillSharpClientError, PermissionAction, PermissionEffect, PermissionScope } from "@chill-sharp/ts-client";
+export { CHILL_SHARP_VUE_CLIENT_VERSION } from "./version.js";

package/dist/plugin.d.ts

@@ -0,0 +1,12 @@
+import type { InjectionKey, Plugin } from "vue";
+import { ChillSharpClient } from "@chill-sharp/ts-client";
+import type { ChillSharpClientOptions } from "@chill-sharp/ts-client";
+export interface ChillSharpVueOptions {
+    baseUrl: string;
+    client?: ChillSharpClient;
+    options?: ChillSharpClientOptions;
+}
+export declare const chillSharpClientKey: InjectionKey<ChillSharpClient>;
+export declare function createChillSharpClient(options: ChillSharpVueOptions): ChillSharpClient;
+export declare function createChillSharpPlugin(options: ChillSharpVueOptions): Plugin;
+export declare function useChillSharpClient(): ChillSharpClient;

package/dist/plugin.js

@@ -0,0 +1,42 @@
+/*
+ * ChillSharp is a lightweight .NET library that sits on top of Entity Framework Core
+ * and turns an existing data model into a fully working REST API with almost no setup.
+ * Copyright (C) 2025 Andrea Piovesan
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+import { inject } from "vue";
+import { ChillSharpClient } from "@chill-sharp/ts-client";
+export const chillSharpClientKey = Symbol("ChillSharpClient");
+export function createChillSharpClient(options) {
+    if (options.client) {
+        return options.client;
+    }
+    return new ChillSharpClient(options.baseUrl, options.options);
+}
+export function createChillSharpPlugin(options) {
+    const client = createChillSharpClient(options);
+    return {
+        install(app) {
+            app.provide(chillSharpClientKey, client);
+        }
+    };
+}
+export function useChillSharpClient() {
+    const client = inject(chillSharpClientKey, null);
+    if (!client) {
+        throw new Error("useChillSharpClient requires createChillSharpPlugin() to be installed.");
+    }
+    return client;
+}

package/dist/version.d.ts

@@ -0,0 +1 @@
+export declare const CHILL_SHARP_VUE_CLIENT_VERSION = "0.1.0";

package/dist/version.js

@@ -0,0 +1,19 @@
+/*
+ * ChillSharp is a lightweight .NET library that sits on top of Entity Framework Core
+ * and turns an existing data model into a fully working REST API with almost no setup.
+ * Copyright (C) 2025 Andrea Piovesan
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+export const CHILL_SHARP_VUE_CLIENT_VERSION = "0.1.0";

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@chill-sharp/vue-client",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/e-500/chill-sharp.git",
+    "directory": "extra/chill-sharp-vue-client"
+  },
+  "version": "1.1.12",
+  "description": "Vue client helpers for generic ChillSharp services",
+  "license": "AGPL-3.0-or-later",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "check": "tsc -p tsconfig.json --noEmit",
+    "prepare": "npm run build",
+    "prepack": "npm run build"
+  },
+  "keywords": [
+    "chillsharp",
+    "vue",
+    "typescript",
+    "client",
+    "composables"
+  ],
+  "author": "Andrea Piovesan",
+  "peerDependencies": {
+    "vue": "^3.4.0",
+    "@chill-sharp/ts-client": "^1.1.12"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.2",
+    "@chill-sharp/ts-client": "file:../chill-sharp-ts-client"
+  }
+}
+