nuxt-ollama 1.0.1

package/README.md

@@ -0,0 +1,137 @@
+# Nuxt Ollama
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+[![Nuxt][nuxt-src]][nuxt-href]
+
+Simple integration of the official Ollama JavaScript Library for your Nuxt application.
+
+- [✨  Release Notes](/CHANGELOG.md)
+
+<!-- - [🏀 Online playground](https://stackblitz.com/github/jericho/nuxt-ollama?file=playground%2Fapp.vue) -->
+<!-- - [📖 &nbsp;Documentation](https://example.com) -->
+
+## Features
+
+- Vue 3 composable
+- Server utils
+
+usage on pages or server side:
+```ts
+const ollama = useOllama()
+
+const response = await ollama.chat({
+  model: 'llama3.1',
+  messages: [{ role: 'user', content: 'Why is the sky blue?' }],
+})
+console.log(response.message.content)
+```
+
+See official [Ollama JavaScript Library documentation](https://github.com/ollama/ollama-js) for more information or examples.
+
+## Settings
+
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
+  ollama: {
+    protocol: 'http', // or 'https'
+    host: 'localhost', //domain or ip address
+    port: 11434, // port
+    proxy: false, // use proxy
+  }
+})
+```
+
+## Quick Setup
+
+Install the module to your Nuxt application with one command: *(Pending module approval on Nuxt Module)*
+```bash
+npx nuxi module add nuxt-ollama
+```
+
+<details>
+<summary>Or install it with your favorite package manager:</summary>
+
+```bash
+# NPM:
+npm install nuxt-ollama
+
+# PNPM:
+pnpm add nuxt-ollama
+
+# Yarn:
+yarn add nuxt-ollama
+
+# Bun
+bun add nuxt-ollama
+```
+
+Add `nuxt-ollama` to the `modules` section of `nuxt.config.js`:
+
+```ts
+// nuxt.config.ts
+export default {
+  modules: [
+    'nuxt-ollama',
+  ],
+}
+```
+</details>
+
+That's it! You can now use Nuxt Ollama in your Nuxt app ✨
+
+## Contribution
+
+Contributions are welcome, feel free to open an issue or submit a pull request!
+
+*guidelines coming soon*
+
+<details>
+  <summary>Local development</summary>
+
+  ```bash
+  # Install dependencies
+  bun install
+  
+  # Generate type stubs
+  bun dev:prepare
+  
+  # Develop with the playground
+  bun dev
+  
+  # Build the playground
+  bun dev:build
+  
+  # Run ESLint
+  bun lint
+  
+  # Run Vitest
+  bun test
+  bun test:watch
+  
+  # Release new version
+  bun release
+  ```
+
+</details>
+
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/nuxt-ollama/latest.svg?style=flat&colorA=020420&colorB=00DC82
+
+[npm-version-href]: https://npmjs.com/package/nuxt-ollama
+
+[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-ollama.svg?style=flat&colorA=020420&colorB=00DC82
+
+[npm-downloads-href]: https://npmjs.com/package/nuxt-ollama
+
+[license-src]: https://img.shields.io/npm/l/nuxt-ollama.svg?style=flat&colorA=020420&colorB=00DC82
+
+[license-href]: https://npmjs.com/package/nuxt-ollama
+
+[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
+
+[nuxt-href]: https://nuxt.com

package/dist/module.cjs

@@ -0,0 +1,5 @@
+module.exports = function(...args) {
+  return import('./module.mjs').then(m => m.default.call(this, ...args))
+}
+const _meta = module.exports.meta = require('./module.json')
+module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.mts

@@ -0,0 +1,8 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import { OllamaOptions } from '~/src/types';
+
+interface ModuleOptions extends OllamaOptions {
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
+
+export { type ModuleOptions, _default as default };

package/dist/module.d.ts

@@ -0,0 +1,8 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import { OllamaOptions } from '~/src/types';
+
+interface ModuleOptions extends OllamaOptions {
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
+
+export { type ModuleOptions, _default as default };

package/dist/module.json

@@ -0,0 +1,12 @@
+{
+  "name": "nuxt-ollama",
+  "configKey": "ollama",
+  "compatibility": {
+    "nuxt": ">=3.12"
+  },
+  "version": "1.0.1",
+  "builder": {
+    "@nuxt/module-builder": "0.8.1",
+    "unbuild": "2.0.0"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,33 @@
+import { defineNuxtModule, createResolver, addImports, addServerImportsDir } from '@nuxt/kit';
+import { defu } from 'defu';
+
+const module = defineNuxtModule({
+  meta: {
+    name: "nuxt-ollama",
+    configKey: "ollama",
+    compatibility: {
+      nuxt: ">=3.12"
+    }
+  },
+  // Default configuration options of the Nuxt module
+  defaults: {
+    protocol: "http",
+    host: "localhost",
+    port: 11434,
+    proxy: false
+  },
+  setup(_options, _nuxt) {
+    const resolver = createResolver(import.meta.url);
+    const runtimeConfig = _nuxt.options.runtimeConfig;
+    const currentConfig = runtimeConfig.public.ollama ?? {};
+    runtimeConfig.public.ollama = defu(currentConfig, _options);
+    addImports({
+      name: "useOllama",
+      as: "useOllama",
+      from: resolver.resolve("./runtime/composables/useOllama")
+    });
+    addServerImportsDir(resolver.resolve("./runtime/server/utils"));
+  }
+});
+
+export { module as default };

package/dist/runtime/composables/useOllama.d.ts

@@ -0,0 +1 @@
+export { useOllama } from '../useOllama.js';

package/dist/runtime/composables/useOllama.js

@@ -0,0 +1 @@
+export { useOllama } from "../useOllama.js";

package/dist/runtime/server/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../../.nuxt/tsconfig.server.json",
+}

package/dist/runtime/server/utils/useOllama.d.ts

@@ -0,0 +1 @@
+export { useOllama } from '../../useOllama.js';

package/dist/runtime/server/utils/useOllama.js

@@ -0,0 +1 @@
+export { useOllama } from "../../useOllama.js";

package/dist/runtime/useOllama.d.ts

@@ -0,0 +1,2 @@
+import { Ollama } from 'ollama';
+export declare function useOllama(): Ollama;

package/dist/runtime/useOllama.js

@@ -0,0 +1,9 @@
+import { Ollama } from "ollama";
+import { useRuntimeConfig } from "#imports";
+export function useOllama() {
+  const options = useRuntimeConfig().public.ollama;
+  return new Ollama({
+    host: `${options.protocol}://${options.host}:${options.port}`,
+    proxy: options.proxy
+  });
+}

package/dist/types.d.mts

@@ -0,0 +1 @@
+export { type ModuleOptions, default } from './module.js'

package/dist/types.d.ts

@@ -0,0 +1 @@
+export { type ModuleOptions, default } from './module'

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "nuxt-ollama",
+  "version": "1.0.1",
+  "description": "Easy ollama integration for Nuxt",
+  "repository": "jericho1060/nuxt-ollama",
+  "license": "MIT",
+  "type": "module",
+  "author": {
+    "name": "Jericho",
+    "url": "https://jericho.dev"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/module.mjs",
+      "require": "./dist/module.cjs"
+    }
+  },
+  "main": "./dist/module.cjs",
+  "types": "./dist/types.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prepack": "nuxt-module-build build",
+    "dev": "nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^3.12.4",
+    "defu": "^6.1.4",
+    "ollama": "^0.5.6"
+  },
+  "devDependencies": {
+    "@nuxt/devtools": "^1.3.9",
+    "@nuxt/eslint-config": "^0.3.13",
+    "@nuxt/module-builder": "^0.8.1",
+    "@nuxt/schema": "^3.12.4",
+    "@nuxt/test-utils": "^3.13.1",
+    "@types/node": "^20.14.11",
+    "changelogen": "^0.5.5",
+    "eslint": "^9.7.0",
+    "nuxt": "^3.12.4",
+    "typescript": "latest",
+    "vitest": "^2.0.3",
+    "vue-tsc": "^2.0.26"
+  }
+}