create-message-kit 1.2.22 → 1.2.24

package/README.md

@@ -9,13 +9,10 @@ bun create message-kit
 ```
 
 ```bash
-npx create-message-kit
+npx create-message-kit@latest
 ```
 
 ```bash
 yarn create message-kit
-```
-
-```bash [npm]
-npm init message-kit
+// use yarn create message-kit@latest in yarn > v2
 ```

package/index.js

@@ -7,7 +7,7 @@ import { default as fs } from "fs-extra";
 import { isCancel } from "@clack/prompts";
 import { detect } from "detect-package-manager";
 import pc from "picocolors";
-const defVersion = "1.2.22";
+const defVersion = "1.2.24";
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
 // Read package.json to get the version
@@ -96,19 +96,20 @@ async function updatePackagejson(destDir, templateType) {
 }
 
 async function gatherProjectInfo() {
-  const templateOptions = fs
-    .readJsonSync(resolve(__dirname, "./templates.json"))
-    .filter(
-      (template) =>
-        template.href.includes("ens") || template.href.includes("simple"),
-    );
+  const templateOptions = [
+    {
+      value: "templates/simple",
+      label: "Simple - Basic template with minimal setup",
+    },
+    {
+      value: "templates/ens",
+      label: "ENS - Template with ENS integration",
+    },
+  ];
 
   const templateType = await select({
     message: "Select the type of template to initialize:",
-    options: templateOptions.map(({ title, description, href }) => ({
-      value: href,
-      label: `${title} - ${description}`,
-    })),
+    options: templateOptions,
   });
 
   if (isCancel(templateType)) {
@@ -219,8 +220,7 @@ async function detectPackageManager() {
 
     const userAgent = process.env.npm_config_user_agent;
 
-    // Check if running through npm init
-    if (userAgent?.startsWith("npm")) {
+    if (userAgent?.startsWith("npm") || userAgent?.startsWith("npx")) {
       return "npm";
     }
 
@@ -286,13 +286,13 @@ ${envExampleContent}
 3. **Install dependencies:**
 
 \`\`\`sh
-${packageManager} install
+${packageManager.split("@")[0]} install
 \`\`\`
 
 4. **Run the project:**
 
 \`\`\`sh
-${packageManager === "npm" ? "npm run" : packageManager} dev
+${packageManager.split("@")[0]} run dev
 \`\`\`
 
 5. Enjoy!

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "create-message-kit",
-  "version": "1.2.22",
+  "version": "1.2.24",
   "license": "MIT",
   "type": "module",
   "main": "index.js",
   "module": "index.js",
   "bin": "index.js",
   "files": [
-    "templates.json",
     "templates/**/*"
   ],
   "scripts": {

package/templates/ens/.cursorrules

@@ -112,118 +112,6 @@ export async function handler(context: XMTPContext) {
   await context.requestPayment(amount, token, receiverAddress);
 }
 
-
-## Types
-
-import { XMTPContext } from "../plugins/xmtp.js";
-import { ClientOptions, GroupMember } from "@xmtp/node-sdk";
-import { ContentTypeId } from "@xmtp/content-type-primitives";
-
-export type MessageAbstracted = {
-  id: string;
-  sent: Date;
-  content: {
-    text?: string | undefined;
-    reply?: string | undefined;
-    previousMsg?: string | undefined;
-    react?: string | undefined;
-    content?: any | undefined;
-    params?: any | undefined;
-    reference?: string | undefined;
-    skill?: string | undefined;
-  };
-  version: "v2" | "v3";
-  sender: AbstractedMember;
-  typeId: string;
-};
-export type GroupAbstracted = {
-  id: string;
-  sync: () => Promise<void>;
-  addMembers: (addresses: string[]) => Promise<void>;
-  addMembersByInboxId: (inboxIds: string[]) => Promise<void>;
-  send: (content: string, contentType?: ContentTypeId) => Promise<string>;
-  isAdmin: (inboxId: string) => boolean;
-  isSuperAdmin: (inboxId: string) => boolean;
-  admins: string[];
-  superAdmins: string[];
-  createdAt: Date;
-  members: GroupMember[];
-};
-export type SkillResponse = {
-  code: number;
-  message: string;
-  data?: any;
-};
-
-export type SkillHandler = (
-  context: XMTPContext,
-) => Promise<SkillResponse | void>;
-
-export type Handler = (context: XMTPContext) => Promise<void>;
-
-export type RunConfig = {
-  // client options from XMTP client
-  client?: ClientOptions;
-  // private key to be used for the client, if not, default from env
-  privateKey?: string;
-  // if true, the init log message with messagekit logo and stuff will be hidden
-  experimental?: boolean;
-  // hide the init log message with messagekit logo and stuff
-  hideInitLogMessage?: boolean;
-  // if true, attachments will be enabled
-  attachments?: boolean;
-  // if true, member changes will be enabled, like adding members to the group
-  memberChange?: boolean;
-  // skills to be used
-  agent?: Agent;
-  // model to be used
-  gptModel?: string;
-};
-export interface SkillParamConfig {
-  default?: string | number | boolean;
-  type:
-    | "number"
-    | "string"
-    | "username"
-    | "quoted"
-    | "address"
-    | "prompt"
-    | "url";
-  plural?: boolean;
-  values?: string[]; // Accepted values for the parameter
-}
-
-export interface Frame {
-  title: string;
-  buttons: { content: string; action: string; target: string }[];
-  image: string;
-}
-export interface Agent {
-  name: string;
-  description: string;
-  tag: string;
-  skills: Skill[];
-}
-export interface Skill {
-  skill: string;
-  handler?: SkillHandler | undefined;
-  adminOnly?: boolean;
-  description: string;
-  examples: string[];
-  params: Record<string, SkillParamConfig>;
-}
-
-export interface AbstractedMember {
-  inboxId: string;
-  address: string;
-  accountAddresses: string[];
-  installationIds?: string[];
-}
-
-export type MetadataValue = string | number | boolean;
-export type Metadata = Record<string, MetadataValue | MetadataValue[]>;
-
-
 ## Example final prompt
 
 Your are a helpful and playful ens agent called @bot that lives inside a messaging app called Converse.

package/templates/ens/package.json

@@ -8,8 +8,7 @@
     "start": "node dist/index.js"
   },
   "dependencies": {
-    "@xmtp/message-kit": "workspace:*",
-    "resend": "^4.0.1"
+    "@xmtp/message-kit": "workspace:*"
   },
   "devDependencies": {
     "@types/node": "^20.14.2",

package/templates/ens/src/index.ts

@@ -1,10 +1,4 @@
-import {
-  run,
-  agentReply,
-  replaceVariables,
-  XMTPContext,
-  Agent,
-} from "@xmtp/message-kit";
+import { run, Agent } from "@xmtp/message-kit";
 import { systemPrompt } from "./prompt.js";
 import { checkDomain } from "./skills/check.js";
 import { cool } from "./skills/cool.js";
@@ -13,41 +7,13 @@ import { register } from "./skills/register.js";
 import { renew } from "./skills/renew.js";
 import { pay } from "./skills/pay.js";
 import { reset } from "./skills/reset.js";
-import fs from "fs";
 
-// [!region skills]
 export const agent: Agent = {
   name: "Ens Agent",
   tag: "@bot",
   description: "A ens agent with a lot of skills.",
-  skills: [
-    ...checkDomain,
-    ...cool,
-    ...info,
-    ...register,
-    ...renew,
-    ...reset,
-    ...pay,
-  ],
+  skills: [checkDomain, cool, info, register, renew, reset, pay],
+  systemPrompt: systemPrompt,
 };
-// [!endregion skills]
 
-// [!region run1]
-run(
-  async (context: XMTPContext) => {
-    const {
-      message: { sender },
-      agent,
-    } = context;
-
-    let prompt = await replaceVariables(systemPrompt, sender.address, agent);
-    // [!endregion run1]
-    //This is only used for to update the docs.
-    fs.writeFileSync("example_prompt.md", prompt);
-    // [!region run2]
-    await agentReply(context, prompt);
-  },
-  { agent },
-);
-
-// [!endregion run2]
+run(agent);

package/templates/ens/src/prompt.ts

@@ -1,5 +1,5 @@
 export const systemPrompt = `
-Your are a helpful and playful ens agent called {agent_name} that lives inside a messaging app called Converse.
+{vibe}
 
 {rules}
 

package/templates/ens/src/skills/info.ts

@@ -48,9 +48,12 @@ export async function handler(context: XMTPContext) {
   message += `\n\nWould you like to tip the domain owner for getting there first 🤣?`;
   message = message.trim();
 
-  if (
-    await context.isOnXMTP(context.client, context.v2client, sender?.address)
-  ) {
+  const { v2, v3 } = await context.isOnXMTP(
+    context.client,
+    context.v2client,
+    sender?.address,
+  );
+  if (v2 || v3) {
     await context.send(
       `Ah, this domains is in XMTP, you can message it directly`,
     );

package/templates/simple/.cursorrules

@@ -112,118 +112,6 @@ export async function handler(context: XMTPContext) {
   await context.requestPayment(amount, token, receiverAddress);
 }
 
-
-## Types
-
-import { XMTPContext } from "../plugins/xmtp.js";
-import { ClientOptions, GroupMember } from "@xmtp/node-sdk";
-import { ContentTypeId } from "@xmtp/content-type-primitives";
-
-export type MessageAbstracted = {
-  id: string;
-  sent: Date;
-  content: {
-    text?: string | undefined;
-    reply?: string | undefined;
-    previousMsg?: string | undefined;
-    react?: string | undefined;
-    content?: any | undefined;
-    params?: any | undefined;
-    reference?: string | undefined;
-    skill?: string | undefined;
-  };
-  version: "v2" | "v3";
-  sender: AbstractedMember;
-  typeId: string;
-};
-export type GroupAbstracted = {
-  id: string;
-  sync: () => Promise<void>;
-  addMembers: (addresses: string[]) => Promise<void>;
-  addMembersByInboxId: (inboxIds: string[]) => Promise<void>;
-  send: (content: string, contentType?: ContentTypeId) => Promise<string>;
-  isAdmin: (inboxId: string) => boolean;
-  isSuperAdmin: (inboxId: string) => boolean;
-  admins: string[];
-  superAdmins: string[];
-  createdAt: Date;
-  members: GroupMember[];
-};
-export type SkillResponse = {
-  code: number;
-  message: string;
-  data?: any;
-};
-
-export type SkillHandler = (
-  context: XMTPContext,
-) => Promise<SkillResponse | void>;
-
-export type Handler = (context: XMTPContext) => Promise<void>;
-
-export type RunConfig = {
-  // client options from XMTP client
-  client?: ClientOptions;
-  // private key to be used for the client, if not, default from env
-  privateKey?: string;
-  // if true, the init log message with messagekit logo and stuff will be hidden
-  experimental?: boolean;
-  // hide the init log message with messagekit logo and stuff
-  hideInitLogMessage?: boolean;
-  // if true, attachments will be enabled
-  attachments?: boolean;
-  // if true, member changes will be enabled, like adding members to the group
-  memberChange?: boolean;
-  // skills to be used
-  agent?: Agent;
-  // model to be used
-  gptModel?: string;
-};
-export interface SkillParamConfig {
-  default?: string | number | boolean;
-  type:
-    | "number"
-    | "string"
-    | "username"
-    | "quoted"
-    | "address"
-    | "prompt"
-    | "url";
-  plural?: boolean;
-  values?: string[]; // Accepted values for the parameter
-}
-
-export interface Frame {
-  title: string;
-  buttons: { content: string; action: string; target: string }[];
-  image: string;
-}
-export interface Agent {
-  name: string;
-  description: string;
-  tag: string;
-  skills: Skill[];
-}
-export interface Skill {
-  skill: string;
-  handler?: SkillHandler | undefined;
-  adminOnly?: boolean;
-  description: string;
-  examples: string[];
-  params: Record<string, SkillParamConfig>;
-}
-
-export interface AbstractedMember {
-  inboxId: string;
-  address: string;
-  accountAddresses: string[];
-  installationIds?: string[];
-}
-
-export type MetadataValue = string | number | boolean;
-export type Metadata = Record<string, MetadataValue | MetadataValue[]>;
-
-
 ## Example final prompt
 
 Your are a helpful and playful ens agent called @bot that lives inside a messaging app called Converse.

package/templates/simple/src/index.ts

@@ -5,7 +5,6 @@ import {
   XMTPContext,
   Agent,
 } from "@xmtp/message-kit";
-
 import { systemPrompt } from "./prompt.js";
 
 export const agent: Agent = {
@@ -13,13 +12,15 @@ export const agent: Agent = {
   tag: "@bot",
   description: "Use GPT to generate text responses.",
   skills: [],
-};
+  onMessage: async (context: XMTPContext) => {
+    const {
+      message: { sender },
+      agent,
+    } = context;
 
-run(async (context: XMTPContext) => {
-  const {
-    message: { sender },
-  } = context;
+    let prompt = await replaceVariables(systemPrompt, sender.address, agent);
+    await agentReply(context, prompt);
+  },
+};
 
-  let prompt = await replaceVariables(systemPrompt, sender.address, agent);
-  await agentReply(context, prompt);
-});
+run(agent);