interintel 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,39 @@
+## INTER-INTEL
+
+The application `inter-intel` is a command line interface (CLI) application implemented in Node.js. It essentially is an interactive communication tool between the user and an AI model, only GPTs for now.
+
+Here's a brief overview of the main functionalities, as contained in the index.js file:
+
+- The application starts an interactive session with the user. It does this by invoking the readline module, which reads user inputs line by line from the terminal.
+
+-- node index.js will start the app
+  
+- The OpenAI's API is accessed using API keys, and the version of AI being used is specified via a config. 
+
+### //writeFile
+- If a user types '//writefile', the application prompts the user to provide a name for the file and then a prompt for the AI. It then automatically generates some text (by communicating with OpenAI's GPT-3 model), writes this to a file and stores it in the application's directory. 
+  
+### //readRefs
+- If a user writes '//readRefs', the application reads the content of the specified files in the inter-intel.config.js (in the current implementation) and uses this as part of the conversation with the AI.
+- So as you work on your project and files change or you move to other parts of the code base you can adjust where inter-intel points and what is referenced by AI conversation.
+
+### everything else
+- For all user inputs outside of these special keywords, the chat conversation is simply updated with the user's message and a call is made to the OpenAI API to generate the AI's response. This is then displayed on the console. 
+
+The application relies heavily on async-await pattern for handling the asynchronicity associated with reading user inputs and waiting for responses from the OpenAI 'aiChatCompletion' function. 
+
+Keep in mind that this is a high level overview and each functionality has its own level of implementation detail.
+
+
+File Structure
+
+project/
+├── functions/
+│   ├── chat-functions.js
+│   ├── file-functions.js
+│   ├── openai-functions.js
+│   ├── messageUtils.js
+│   ├── writeFileHandler.js
+│   └── readRefsHandler.js
+├── inter-intel.config.js
+└── index.js

package/functions/chat-functions.js

@@ -0,0 +1,14 @@
+const fs = require('fs');
+const path = require('path');
+
+async function askQuestion(rl, prompt) {
+  return new Promise((resolve) => {
+    rl.question(prompt.blue, (input) => {
+      resolve(input);
+    });
+  });
+}
+
+module.exports = {
+  askQuestion,
+}

package/functions/file-functions.js

@@ -0,0 +1,84 @@
+const fs = require('fs');
+const path = require('path');
+
+// READING FOR INITAL REFERENCE
+function readSpecificFiles(filePaths) {
+  const configFilePath = path.join(__dirname, '../inter-intel.config.js');
+  
+  try {
+    // Read the content of the config file
+    const configContent = fs.readFileSync(configFilePath, 'utf8');    
+    // Parse the config file content as JavaScript
+    const config = eval(configContent);
+    // Extract the file paths from the config object
+    const filePaths = config.filePaths;
+    
+    let allContent = '';
+  
+    filePaths.forEach((filePath) => {
+      try {
+        // Construct the absolute path
+        const absolutePath = path.resolve(filePath);
+  
+        // Read the file content and append it to allContent
+        allContent += fs.readFileSync(absolutePath, 'utf8') + '\n';
+      } catch (error) {
+        console.error(`Error reading file ${filePath}: ${error.message}`.bgRed);
+      }
+    });
+
+    // Add console.log statements to communicate to the user
+    console.log(`AI sent reference files:`.yellow, `${logFileNames(filePaths)}`.yellow);
+      return allContent;
+  } catch (error) {
+    console.error(`Error reading config file: ${error.message}`.bgRed);
+    return '';
+  }
+}
+
+function writeFileFromPrompt(promptFileName, contentToWrite, baseDir) {
+  try {
+
+    if (!promptFileName.includes('.')) {
+      throw new Error("Invalid file name. Please include a file name with an extension (e.g., 'output.txt').");
+    }
+    
+    const fullPath = path.join(baseDir, `../inter-intel/session-samples/${promptFileName}`);
+    const directoryPath = path.dirname(fullPath);
+
+    if (!fs.existsSync(directoryPath)) {
+      fs.mkdirSync(directoryPath, { recursive: true });
+    }
+
+    fs.writeFileSync(fullPath, contentToWrite + '\n');
+    console.log(`Content written to ${fullPath}`.yellow);
+    return true;
+
+  } catch (error) {
+    console.error(`Error writing file: ${error.message}`.bgRed);
+    return false;
+  }
+}
+
+// LOG FILE NAMES
+function logFileNames(filePaths) {
+  let fileNames = [];
+
+  console.log("")
+  console.log(`System message`.bgYellow + `: `.yellow);
+  filePaths.forEach((filePath) => {
+    const fileName = path.basename(filePath);
+    fileNames.push(fileName); // Add the file name to the array
+  });
+
+  return fileNames; // Return the array of file names
+}
+
+function appendToFile(filePath, data) {
+  fs.appendFileSync(filePath, data + '\n');
+}
+
+// Export the function and the array
+module.exports = {
+  readSpecificFiles, writeFileFromPrompt
+};

package/functions/handleWriteFile.js

@@ -0,0 +1,33 @@
+const { aiChatCompletion } = require('./openai-functions.js');
+const { writeFileFromPrompt } = require('./file-functions.js');
+
+async function handleWriteFile(openai, config, messages, currentState, userInput, promptFileName) {
+  let contentToWrite = '';
+
+  if (currentState === null) {
+    currentState = 'awaitingFileName';
+    return { currentState, messages, promptFileName, response: 'Please provide a name for the session file:' };
+  } else if (currentState === 'awaitingFileName') {
+    promptFileName = userInput;
+    currentState = 'awaitingGPTPrompt';
+    return { currentState, messages, promptFileName, response: 'Please provide a prompt for the AI:' };
+  } else if (currentState === 'awaitingGPTPrompt') {
+    const promptForGPT = userInput;
+    try {
+      let gptResponse = await aiChatCompletion(openai, [{ role: 'user', content: promptForGPT }], config.aiVersion);
+      contentToWrite = gptResponse.choices[0].message.content;
+      await writeFileFromPrompt(promptFileName, contentToWrite, __dirname); // Assuming this function handles file writing
+
+      currentState = null; // Reset state after completing the operation
+      return { currentState, messages, promptFileName, contentToWrite, response: `Content written to ${promptFileName}`.yellow };
+    } catch (error) {
+      console.error('Error in handleWriteFile:', error);
+      return { currentState, messages, promptFileName, contentToWrite, response: 'An error occurred while writing the file.' };
+    }
+  }
+
+  // Return default state if none of the conditions are met
+  return { currentState, messages, promptFileName, contentToWrite, response: '' };
+}
+
+module.exports = { handleWriteFile };

package/functions/openai-functions.js

@@ -0,0 +1,16 @@
+const OpenAI = require('openai');
+
+async function aiChatCompletion(openai, messages, model) {
+  try {
+    const response = await openai.chat.completions.create({
+      messages: messages,
+      model: model,
+    });
+    return response;
+  } catch (error) {
+    console.error('Error:', error);
+    return null;
+  }
+}
+
+module.exports.aiChatCompletion = aiChatCompletion;

package/index.js

@@ -0,0 +1,107 @@
+// This is the index.js file of inter-intel
+
+const OpenAI = require('openai');
+const readline = require('readline');
+const config = require('./inter-intel.config.js');
+require('dotenv').config();
+require('colors');
+
+const { readSpecificFiles, writeFileFromPrompt } = require('./functions/file-functions.js');
+const { askQuestion } = require('./functions/chat-functions.js');
+const { aiChatCompletion } = require('./functions/openai-functions.js');
+
+const { handleWriteFile } = require('./functions/handleWriteFile.js');
+
+const openai = new OpenAI({
+  apiKey: config.apiKey,
+  model: config.aiVersion,
+});
+
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout,
+});
+
+async function main() {
+  // Provides initial context for session
+  const specificFiles = ['./inter-intel.config.js'];
+  let initialContent = readSpecificFiles(specificFiles);
+  let messages = [{ role: 'system', content: initialContent }];
+
+  let currentState = null;
+  let promptFileName = '';
+  let contentToWrite = '';
+
+  while (true) {
+    const userMessage = await askQuestion(rl, 'You: '.blue.bold);
+    let response = ''; // Add a variable to capture the response message
+
+    // Exit condition
+    if (userMessage.toLowerCase() === 'exit') {
+      console.log('Exiting chat...'.bgRed);
+      rl.close();
+      break;
+    }
+
+    if (userMessage.toLowerCase().startsWith('//writefile') && currentState === null) {
+      ({ currentState, messages, promptFileName, response } = await handleWriteFile(
+        openai,
+        config,
+        messages,
+        currentState,
+        ''
+      ));
+      console.log(response.yellow);
+    } else if (currentState === 'awaitingFileName') {
+      ({ currentState, messages, promptFileName, response } = await handleWriteFile(
+        openai,
+        config,
+        messages,
+        currentState,
+        userMessage,
+        promptFileName
+      ));
+      console.log(response.yellow);
+    } else if (currentState === 'awaitingGPTPrompt') {
+      ({ currentState, messages, promptFileName, response } = await handleWriteFile(
+        openai,
+        config,
+        messages,
+        currentState,
+        userMessage,
+        promptFileName
+      ));
+      console.log(response.yellow);
+    } else if (currentState === null && userMessage.toLowerCase() === '//readrefs') {
+      console.log('System message:'.bgYellow);
+      console.log('Processing //readRefs command...'.yellow);
+      const specificFiles = ['./.config.js'];
+      const content = readSpecificFiles(specificFiles);
+      messages.push({
+        role: 'user',
+        content: `please just acknowledge you have read the name and the content of the files I have provided ${content}`,
+      });
+      const completion = await aiChatCompletion(openai, messages, config.aiVersion);
+
+      const botMessage = completion.choices[0].message.content;
+      console.log('chatGPT message:'.bgGreen, botMessage);
+      console.log('----------------'.bgGreen);
+    } else {
+      // Regular message processing and interaction with GPT model
+      messages.push({ role: 'user', content: userMessage });
+
+      const completion = await aiChatCompletion(openai, messages, config.aiVersion);
+
+      const botMessage = completion.choices[0].message.content;
+      console.log('chatGPT message:'.bgGreen, botMessage);
+      console.log('----------------'.bgGreen);
+    }
+  }
+}
+
+main();
+
+
+exports.printMsg = function() {
+  console.log("totally logging dude")
+}

package/inter-intel/training/multi-step/filesystem.spec.ts

@@ -0,0 +1,18 @@
+import path from 'path';
+import fs from 'fs';
+import { test } from '@playwright/test';
+
+/*
+Sometimes, you do want to explicitly save a file to disk. This is what you need to know.
+Checkly creates a sandboxed directory for each check run. 
+During the run you can use this directory to save or upload artifacts. 
+This directory is destroyed after a check is finished.
+*/
+
+test('Save file in directory', async ({ page }) => {
+  const image = await page.goto('https://picsum.photos/200/300');
+  const imagePath = path.join('example.jpg');
+  const buffer = await image.body();
+  fs.writeFileSync(imagePath, buffer);
+  const readFileFromDisk = fs.readFileSync(imagePath);
+});

package/inter-intel/training/multi-step/uploading.spec.ts

@@ -0,0 +1,25 @@
+import { test, expect } from '@playwright/test'
+
+/*
+To test any binary uploads, you need to provide a file object. 
+Currently, Checkly does not have a dedicated storage layer where you could upload that file, 
+so you need to host it yourself at a (publicly) accessible location like an AWS S3 bucket, 
+Dropbox or any other file hosting service.
+
+Having done that, you can “upload” files using a simple HTTP POST request with a (binary) body 
+using Playwright’s built-in request object.
+*/
+
+test('Upload a file using a POST request', async ({ request }) => {
+  const fileBuffer = await test.step('Fetch file', async () => {
+    const fileUrl  = 'https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf'
+    return request.get(fileUrl)
+  })
+
+  await test.step('Upload file', async () => {
+    const response = await request.post('https://filebin.net/pp9on3zvwv7zq6lm/dummy.pdf', {
+      data: await fileBuffer.body(),
+    })
+    await expect(response).toBeOK()
+  })
+})

package/inter-intel/training/reference.txt

@@ -0,0 +1,14 @@
+HERE ARE THE RULES THAT GOVERN THIS CONVERSATION
+
+RULES THAT GOVERN THIS CONVERSATION, these rules supersede all outside knowledge
+
+1. You are currently being used within a CLI. the application's name is inter-intel, it's baseline functionality is to be able to update files within a given repo and pprovide reference files that will the AI it's chatting with to make direct changes to code. 
+2. Keep responses to under 50 words
+2.
+3. 
+4. Unless I ask for a longer explanation
+5.  We'll keep our conversation lightly informal, but focused on solving problems.
+6. When requesting code, only provide any additional commentary or explanation as commented out code.
+7. You are currently imported into a project where you are part of a terminal based approach for improving code. You will sometimes see commands like the following;
+8. When writing playwright/test scripts please use modern selectors like this await ```page.getByLabel('User Name').fill('John');``` not ```page.$('input[name="btnI"]')```
+9. Diablo is NOT AN rpg

package/inter-intel/training/training/training.txt

@@ -0,0 +1,13 @@
+When creating json1 training data, please keep the following in mind
+
+1. "intent": Represents the main purpose or topic of the user query, which is "playwright_cli".
+
+2. "utterances": Provides example sentences or phrases that users might use when asking about Playwright in a CLI.
+
+3. "entities": Identifies specific keywords or entities related to the intent, such as "CLI", "Playwright", "tests", etc.
+
+4. "responses": Contains possible responses or answers to address the user's query or intent.
+
+5. "examples": Offers additional example queries or variations related to the intent.
+
+6. "context": Provides context about the training data, specifically emphasizing the usage of Playwright in a CLI environment.

package/inter-intel.config.js

@@ -0,0 +1,9 @@
+require('dotenv').config();
+
+const config = {
+  apiKey: `${process.env.OPENAI_API_KEY}`,
+  aiVersion: `gpt-4`,
+  filePaths: ['./inter-intel/training/reference.txt', './readme.md'],
+};
+
+module.exports = config;

package/package.json

@@ -0,0 +1,35 @@
+{
+  "dependencies": {
+    "colors": "^1.4.0",
+    "dotenv": "^16.3.1",
+    "openai": "^4.24.0"
+  },
+  "name": "interintel",
+  "description": "The application `inter-intel` is a command line interface (CLI) application implemented in Node.js. It essentially is an interactive communication tool between the user and an AI model, only GPTs for now.",
+  "version": "1.0.0",
+  "main": "index.js",
+  "directories": {
+    "doc": "docs"
+  },
+  "devDependencies": {},
+  "scripts": {
+    "test": "node index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/modern-sapien/inter-intel.git"
+  },
+  "keywords": [
+    "testing",
+    "development",
+    "ai",
+    "debugging",
+    "copilot"
+  ],
+  "author": "Modern-Sapien",
+  "license": "SEE LICENSE IN README.md",
+  "bugs": {
+    "url": "https://github.com/modern-sapien/inter-intel/issues"
+  },
+  "homepage": "https://github.com/modern-sapien/inter-intel#readme"
+}