nuxt-chatgpt 0.1.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Oliver Trajceski
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Oliver Trajceski
+
+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,182 @@
+[![Contributors][contributors-shield]][contributors-url]
+[![Downloads][downloads-shield]][downloads-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+[![LinkedIn][linkedin-shield]][linkedin-url]
+
+<!-- PROJECT LOGO -->
+<br />
+<div>
+  <h1>Nuxt Chatgpt</h3>
+  
+  <img src="images/chatgpt-logo.png" alt="Logo">
+
+  > [ChatGPT](https://openai.com/) integration for [Nuxt 3](https://nuxt.com). 
+  <p align="center">
+    <br />
+    <a href="https://github.com/schnapsterdog/nuxt-chatgpt/issues target="_blank"">Report Bug</a>
+    ·
+    <a href="https://github.com/schnapsterdog/nuxt-chatgpt/issues target="_blank"">Request Feature</a>
+  </p>
+</div>
+
+## About the module
+
+This user-friendly module boasts of an easy integration process that enables seamless implementation into any [Nuxt 3](https://nuxt.com) project. With type-safe integration, you can integrate [ChatGPT](https://openai.com/) into your [Nuxt 3](https://nuxt.com) project without breaking a <b>sweat</b>. Enjoy easy access to the `send` method through the `useChatgpt()` composable. Additionally, the module guarantees <b><i>security</i></b> as requests are routed through a [Nitro Server](https://nuxt.com/docs/guide/concepts/server-engine), thus preventing the exposure of your <b>API Key</b>.
+
+## Features
+
+- 💪 &nbsp; Easy implementation into any [Nuxt 3](https://nuxt.com) project.
+- 👉 &nbsp; Type-safe integration of Chatgpt into your [Nuxt 3](https://nuxt.com) project.
+- 🕹️ &nbsp; Provides a `useChatgpt()` composable that grants easy access to the `send` method.
+- 🔥 &nbsp; Ensures security by routing requests through a [Nitro Server](https://nuxt.com/docs/guide/concepts/server-engine), preventing the <b>API Key</b> from being exposed.
+- 🧱 &nbsp; It is lightweight and performs well.
+
+## Getting Started
+
+1. Add nuxt-chatgpt dependency to your project
+* npm
+  ```sh
+  npm install --save-dev nuxt-chatgpt
+  ```
+* pnpm
+  ```sh
+  pnpm add -D nuxt-chatgpt
+  ```
+* yarn
+  ```sh
+  yarn add --dev nuxt-chatgpt
+  ```
+2. Add nuxt-chatgpt to the modules section of nuxt.config.ts
+
+```js
+export default defineNuxtConfig({
+  modules: ["nuxt-chatgpt"],
+
+  // entirely optional
+  chatgpt: {
+    apiKey: 'Your apiKey here goes here'
+  },
+})
+```
+That's it! You can now use Nuxt Chatgpt in your Nuxt app 🔥
+
+## Example & Usage
+
+To access the `send` method in the nuxt-chatgpt module, you can use the `useChatgpt()` composable, which provides easy access to the method. The send method requires two parameters:
+
+- `message`: a string representing the text message that you want to send to the GPT-3 model for processing.
+- `options`: an optional object that specifies any additional options you want to pass to the API request, such as the GPT-3 model ID, the number of responses to generate, and the maximum length of each response.
+
+```js
+const { send } = useChatgpt()
+
+const data = ref('')
+const message = ref('')
+
+async function sendMessage() {
+  const response = await send(message.value)
+  data.value = response
+}
+
+```
+
+```html
+<template>
+  <div>
+    <input v-model="message">
+    <button
+      @click="sendMessage"
+      v-text="'Send'"
+    />
+    <div>{{ data }}</div>
+  </div>
+</template>
+```
+
+## Module Options
+
+| Name | Type | Default | Description |
+|--|--|--|--|
+|**apiKey**|`String`|`xxxxxx`|Your apiKey here goes here
+|**isEnabled**|`Boolean`|`true`| Enable or disable the module. `True` by default.
+
+<!-- CONTRIBUTING -->
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
+Don't forget to give the project a star! Thanks again!
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+
+<!-- LICENSE -->
+## License
+
+Distributed under the MIT License. See `LICENSE.txt` for more information.
+
+<!-- CONTACT -->
+## Contact
+
+Oliver Trajceski - [LinkedIn](https://mk.linkedin.com/in/oliver-trajceski-8a28b070) - oliver@akrinum.com
+
+Project Link: [https://github.com/schnapsterdog/nuxt-chatgpt](https://github.com/schnapsterdog/nuxt-chatgpt)
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Generate type stubs
+npm run dev:prepare
+
+# Develop with the playground
+npm run dev
+
+# Build the playground
+npm run dev:build
+
+# Run ESLint
+npm run lint
+
+# Run Vitest
+npm run test
+npm run test:watch
+
+# Release new version
+npm run release
+```
+
+
+<!-- ACKNOWLEDGMENTS -->
+## Acknowledgments
+
+Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!
+
+* [Choose an Open Source License](https://choosealicense.com)
+* [Img Shields](https://shields.io)
+* [GitHub Pages](https://pages.github.com)
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[contributors-shield]: https://img.shields.io/github/contributors/schnapsterdog/nuxt-chatgpt.svg?style=for-the-badge
+[contributors-url]: https://github.com/schnapsterdog/nuxt-chatgpt/graphs/contributors
+[downloads-shield]: https://img.shields.io/npm/dw/nuxt-chatgpt.svg?style=for-the-badge
+[downloads-url]: https://www.npmjs.com/package/nuxt-chatgpt
+[stars-shield]: https://img.shields.io/github/stars/nuxt-chatgpt.svg?style=for-the-badge
+[stars-url]: https://github.com/schnapsterdog/nuxt-chatgpt/stargazers
+[issues-shield]: https://img.shields.io/github/issues/schnapsterdog/nuxt-chatgpt.svg?style=for-the-badge
+[issues-url]: https://github.com/schnapsterdog/nuxt-chatgpt/issues
+[license-shield]: https://img.shields.io/github/license/schnapsterdog/nuxt-chatgpt.svg?style=for-the-badge
+[license-url]: https://github.com/schnapsterdog/nuxt-chatgpt/blob/master/LICENSE.txt
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
+[linkedin-url]: https://mk.linkedin.com/in/oliver-trajceski-8a28b070
+[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
+[Vue-url]: https://vuejs.org/

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.ts

@@ -0,0 +1,19 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+interface ModuleOptions {
+    /**
+     * Set chatGPT apiKey
+     * @default undefined
+     * @description Set your chatGPT apiKey
+    */
+    apiKey?: string;
+    /**
+     * Setting to `false` disables the module.
+     * @default true
+     * @description Use this setting to disable the module.
+    */
+    isEnabled?: boolean;
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
+
+export { ModuleOptions, _default as default };

package/dist/module.json

@@ -0,0 +1,8 @@
+{
+  "name": "nuxt-chatgpt",
+  "configKey": "chatgpt",
+  "compatibility": {
+    "nuxt": "^3.0.0"
+  },
+  "version": "0.1.0"
+}

package/dist/module.mjs

@@ -0,0 +1,42 @@
+import { fileURLToPath } from 'url';
+import { defineNuxtModule, createResolver, addImportsDir, addServerHandler } from '@nuxt/kit';
+
+const configKey = "chatgpt";
+const moduleName = "nuxt-chatgpt";
+const nuxtVersion = "^3.0.0";
+
+const module = defineNuxtModule({
+  meta: {
+    name: moduleName,
+    configKey,
+    compatibility: {
+      nuxt: nuxtVersion
+    }
+  },
+  // Default configuration options of the Nuxt module
+  defaults: {
+    isEnabled: true
+  },
+  setup(options, nuxt) {
+    const { resolve } = createResolver(import.meta.url);
+    const runtimeDir = fileURLToPath(new URL("./runtime", import.meta.url));
+    if (!options.apiKey) {
+      return console.warn(`[${moduleName}]: No '${configKey}.apiKey' option provided!`);
+    }
+    if (!options.isEnabled) {
+      return console.warn(`[${moduleName}] module is disabled and will not be loaded.`);
+    }
+    nuxt.options.runtimeConfig.public[configKey] = {
+      apiKey: options.apiKey
+    };
+    addImportsDir(resolve("./runtime/composables"));
+    addServerHandler({
+      route: "/api/chatgpt",
+      method: "post",
+      handler: resolve(runtimeDir, "server/api/chatgpt")
+    });
+    nuxt.options.build.transpile.push(runtimeDir);
+  }
+});
+
+export { module as default };

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

@@ -0,0 +1,2 @@
+import type { IChatgptClient } from "../types";
+export declare const useChatgpt: () => IChatgptClient;

package/dist/runtime/composables/useChatgpt.mjs

@@ -0,0 +1,19 @@
+import { createError } from "h3";
+import { getBody, getHeaders } from "../utils/index.mjs";
+export const useChatgpt = () => {
+  const send = async (message) => {
+    try {
+      return await $fetch("/api/chatgpt", {
+        method: "POST",
+        headers: getHeaders(),
+        body: getBody(message)
+      });
+    } catch (error) {
+      throw createError({
+        statusCode: 500,
+        message: "Failed to forward request to server"
+      });
+    }
+  };
+  return { send };
+};

package/dist/runtime/server/api/chatgpt.d.ts

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

package/dist/runtime/server/api/chatgpt.mjs

@@ -0,0 +1,27 @@
+import { createError } from "h3";
+import { Configuration, OpenAIApi } from "openai";
+const config = useRuntimeConfig();
+export default defineEventHandler(async (event) => {
+  const { prompt } = await readBody(event);
+  const configuration = new Configuration({
+    apiKey: config.public.chatgpt.apiKey
+  });
+  const openai = new OpenAIApi(configuration);
+  try {
+    const response = await openai.createCompletion({
+      model: "text-davinci-003",
+      prompt,
+      temperature: 0.5,
+      max_tokens: 2048,
+      top_p: 1,
+      frequency_penalty: 0,
+      presence_penalty: 0
+    });
+    return response.data.choices[0].text?.slice(2);
+  } catch (error) {
+    throw createError({
+      statusCode: 500,
+      message: "Failed to forward request to ChatGPT API"
+    });
+  }
+});

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

@@ -0,0 +1,12 @@
+export interface IHeaders {
+  [key: string]: string;
+}
+
+export interface IChatgptClient {
+  send ( IMessage ) : Promise
+}
+
+export interface IMessage {
+  message: string
+}
+

package/dist/runtime/utils/index.d.ts

@@ -0,0 +1,3 @@
+import type { IHeaders, IMessage } from "../types";
+export declare const getBody: (message: IMessage) => string;
+export declare const getHeaders: () => IHeaders;

package/dist/runtime/utils/index.mjs

@@ -0,0 +1,8 @@
+export const getBody = (message) => {
+  return JSON.stringify({ prompt: message });
+};
+export const getHeaders = () => {
+  return {
+    "Content-Type": "application/json"
+  };
+};

package/dist/types.d.ts

@@ -0,0 +1,10 @@
+
+import { ModuleOptions } from './module'
+
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['chatgpt']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['chatgpt']?: ModuleOptions }
+}
+
+
+export { ModuleOptions, default } from './module'

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "nuxt-chatgpt",
+  "version": "0.1.0",
+  "description": "ChatGPT integration for Nuxt 3",
+  "license": "MIT",
+  "type": "module",
+  "homepage": "https://vuemadness.com.com/nuxt-chatgpt",
+  "bugs": {
+    "url": "https://github.com/schnapsterdog/nuxt-chatgpt/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/schnapsterdog/nuxt-chatgpt"
+  },
+  "contributors": [
+    {
+      "name": "Oliver Trajceski (@schnapsterdog)"
+    }
+  ],
+  "author": {
+    "name": "Oliver Trajceski",
+    "email": "oliver@akrinum.com"
+  },
+  "keywords": [
+    "vue3",
+    "nuxt3",
+    "nuxt",
+    "nuxt.js",
+    "nuxt-chatgpt"
+  ],
+  "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",
+    "dev": "nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:generate": "nuxi generate playground",
+    "dev:prepare": "nuxt-module-build --stub && nuxi prepare playground",
+    "dev:preview": "nuxi preview 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"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^3.2.3",
+    "openai": "^3.2.1"
+  },
+  "devDependencies": {
+    "@nuxt/eslint-config": "^0.1.1",
+    "@nuxt/module-builder": "^0.2.1",
+    "@nuxt/schema": "^3.2.3",
+    "@nuxt/test-utils": "^3.2.3",
+    "changelogen": "^0.5.1",
+    "eslint": "^8.36.0",
+    "nuxt": "^3.2.3",
+    "vitest": "^0.29.2"
+  }
+}