create-glanceway-source 1.0.0

package/dist/index.js

@@ -0,0 +1,161 @@
+#!/usr/bin/env node
+
+// src/index.ts
+import * as fs from "fs";
+import * as path from "path";
+import * as readline from "readline";
+import { fileURLToPath } from "url";
+var __filename = fileURLToPath(import.meta.url);
+var __dirname = path.dirname(__filename);
+var CATEGORIES = [
+  "Developer",
+  "News",
+  "Social",
+  "Finance",
+  "Entertainment",
+  "Productivity",
+  "Other"
+];
+async function prompt(question, defaultValue) {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+  return new Promise((resolve2) => {
+    const displayQuestion = defaultValue ? `${question} (${defaultValue}): ` : `${question}: `;
+    rl.question(displayQuestion, (answer) => {
+      rl.close();
+      resolve2(answer.trim() || defaultValue || "");
+    });
+  });
+}
+async function confirm(question) {
+  const answer = await prompt(`${question} (y/N)`);
+  return answer.toLowerCase() === "y" || answer.toLowerCase() === "yes";
+}
+async function selectCategory() {
+  console.log("\nSelect a category:");
+  CATEGORIES.forEach((cat, index2) => {
+    console.log(`  ${index2 + 1}. ${cat}`);
+  });
+  const selection = await prompt("Enter number", "1");
+  const index = parseInt(selection, 10) - 1;
+  if (index >= 0 && index < CATEGORIES.length) {
+    return CATEGORIES[index];
+  }
+  return "Other";
+}
+function toKebabCase(str) {
+  return str.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-|-$/g, "");
+}
+async function getConfig(projectName) {
+  const name = toKebabCase(projectName);
+  const version = await prompt("Version", "1.0.0");
+  const displayName = await prompt("Display name", projectName);
+  const description = await prompt("Description", "A Glanceway information source");
+  const author = await prompt("Author name");
+  if (!author) {
+    console.error("\u274C Error: Author name is required.");
+    process.exit(1);
+  }
+  const authorUrl = await prompt("Author URL (optional)");
+  const category = await selectCategory();
+  return {
+    name,
+    version,
+    displayName,
+    description,
+    author,
+    authorUrl,
+    category
+  };
+}
+function renderTemplate(content, config) {
+  const authorBlock = config.authorUrl ? `author: ${config.author}
+author_url: ${config.authorUrl}` : `author: ${config.author}`;
+  return content.replace(/<%=\s*name\s*%>/g, config.name).replace(/<%=\s*version\s*%>/g, config.version).replace(/<%=\s*displayName\s*%>/g, config.displayName).replace(/<%=\s*description\s*%>/g, config.description).replace(/<%-\s*authorBlock\s*%>/g, authorBlock).replace(/<%=\s*category\s*%>/g, config.category).replace(/<%=\s*author\s*%>/g, config.author);
+}
+function copyTemplate(templateDir, targetDir, config) {
+  const entries = fs.readdirSync(templateDir, { withFileTypes: true });
+  for (const entry of entries) {
+    const srcPath = path.join(templateDir, entry.name);
+    let targetName = entry.name;
+    if (targetName.endsWith(".ejs")) {
+      targetName = targetName.slice(0, -4);
+    }
+    const targetPath = path.join(targetDir, targetName);
+    if (entry.isDirectory()) {
+      fs.mkdirSync(targetPath, { recursive: true });
+      copyTemplate(srcPath, targetPath, config);
+    } else {
+      let content = fs.readFileSync(srcPath, "utf-8");
+      content = renderTemplate(content, config);
+      fs.writeFileSync(targetPath, content);
+    }
+  }
+}
+function removeDir(dir) {
+  if (fs.existsSync(dir)) {
+    fs.rmSync(dir, { recursive: true, force: true });
+  }
+}
+async function main() {
+  const args = process.argv.slice(2);
+  if (args[0] === "--help" || args[0] === "-h") {
+    console.log(`
+Usage: create-glanceway-source [project-name]
+
+Creates a new Glanceway source project with TypeScript support.
+
+Example:
+  npm create glanceway-source
+  npm create glanceway-source my-source
+`);
+    process.exit(0);
+  }
+  console.log("\n\u{1F4E6} Creating a new Glanceway source\n");
+  let projectName = args[0];
+  if (!projectName) {
+    projectName = await prompt("Project name", "my-source");
+  }
+  if (!projectName) {
+    console.error("\u274C Error: Project name is required.");
+    process.exit(1);
+  }
+  const targetDir = path.resolve(process.cwd(), projectName);
+  if (fs.existsSync(targetDir)) {
+    const overwrite = await confirm(`Directory "${projectName}" already exists. Overwrite?`);
+    if (!overwrite) {
+      console.log("Cancelled.");
+      process.exit(0);
+    }
+    removeDir(targetDir);
+  }
+  const config = await getConfig(projectName);
+  console.log("\n\u{1F680} Creating project...\n");
+  fs.mkdirSync(targetDir, { recursive: true });
+  const templateDir = path.join(__dirname, "..", "template");
+  if (!fs.existsSync(templateDir)) {
+    console.error("\u274C Error: Template directory not found.");
+    process.exit(1);
+  }
+  copyTemplate(templateDir, targetDir, config);
+  console.log(`\u2705 Created project "${projectName}"
+`);
+  console.log("Next steps:");
+  console.log(`  cd ${projectName}`);
+  console.log("  npm install");
+  console.log("  npm run dev    # Watch mode");
+  console.log("  npm run build  # Build for production");
+  console.log("\nOutput files:");
+  console.log("  dist/index.js     - Compiled source code");
+  console.log("  dist/manifest.yaml - Source metadata");
+  console.log("\nTo contribute to glanceway-sources:");
+  console.log("  1. Copy dist/ contents to sources/<your-username>/<source-name>/");
+  console.log("  2. Submit a PR to the glanceway-sources repository");
+  console.log("");
+}
+main().catch((error) => {
+  console.error("Error:", error);
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "create-glanceway-source",
+  "version": "1.0.0",
+  "description": "Create a new Glanceway information source with TypeScript",
+  "type": "module",
+  "bin": {
+    "create-glanceway-source": "./dist/index.js"
+  },
+  "files": [
+    "dist",
+    "template"
+  ],
+  "scripts": {
+    "build": "esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --banner:js='#!/usr/bin/env node'",
+    "dev": "npm run build && node dist/index.js"
+  },
+  "keywords": [
+    "glanceway",
+    "source",
+    "create",
+    "cli",
+    "template"
+  ],
+  "author": "codytseng",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "esbuild": "^0.19.0",
+    "typescript": "^5.3.3"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}

package/template/manifest.yaml.ejs

@@ -0,0 +1,6 @@
+id: <%= author %>/<%= name %>
+version: <%= version %>
+name: <%= displayName %>
+description: <%= description %>
+<%- authorBlock %>
+category: <%= category %>

package/template/package.json.ejs

@@ -0,0 +1,14 @@
+{
+  "name": "<%= name %>",
+  "version": "1.0.0",
+  "description": "<%= description %>",
+  "scripts": {
+    "build": "esbuild src/index.ts --bundle --platform=node --format=cjs --outfile=dist/index.js && cp manifest.yaml dist/",
+    "dev": "esbuild src/index.ts --bundle --platform=node --format=cjs --outfile=dist/index.js --watch"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "esbuild": "^0.19.0",
+    "typescript": "^5.3.3"
+  }
+}

package/template/src/index.ts

@@ -0,0 +1,9 @@
+import type { GlancewayAPI, SourceMethods } from './types';
+
+module.exports = (api: GlancewayAPI): SourceMethods => {
+  return {
+    async refresh() {
+      // TODO: Implement your source logic here
+    },
+  };
+};

package/template/src/types.ts

@@ -0,0 +1,154 @@
+/**
+ * Glanceway Source API
+ *
+ * The main API object passed to your source function.
+ */
+export interface GlancewayAPI {
+  /** Send information items to Glanceway for display */
+  emit(items: InfoItem[]): void;
+
+  /** Make HTTP requests */
+  fetch(url: string, options?: FetchOptions): Promise<FetchResponse>;
+
+  /** Log messages for debugging */
+  log(level: 'info' | 'error' | 'warn' | 'debug', message: string): void;
+
+  /** Persistent key-value storage */
+  storage: StorageAPI;
+
+  /** Access user-configured values */
+  config: ConfigAPI;
+
+  /** Create WebSocket connections */
+  websocket: WebSocketAPI;
+}
+
+/**
+ * Information item displayed in Glanceway
+ */
+export interface InfoItem {
+  /** Unique identifier for the item */
+  id: string | number;
+
+  /** Main display text */
+  title: string;
+
+  /** Secondary text below the title */
+  subtitle?: string;
+
+  /** Link opened when item is clicked */
+  url?: string;
+
+  /** Time associated with the item (ISO string, Unix timestamp, or Date) */
+  timestamp?: Date | string | number;
+}
+
+/**
+ * HTTP request options
+ */
+export interface FetchOptions {
+  /** HTTP method (default: GET) */
+  method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+
+  /** Request headers */
+  headers?: Record<string, string>;
+
+  /** Request body (for POST/PUT) */
+  body?: string;
+
+  /** Request timeout in milliseconds (default: 30000) */
+  timeout?: number;
+}
+
+/**
+ * HTTP response
+ */
+export interface FetchResponse {
+  /** True if status code is 200-299 */
+  ok: boolean;
+
+  /** HTTP status code */
+  status: number;
+
+  /** Response headers */
+  headers: Record<string, string>;
+
+  /** Raw response body */
+  text: string;
+
+  /** Parsed JSON (if response is valid JSON) */
+  json?: unknown;
+}
+
+/**
+ * Persistent storage API
+ *
+ * Data persists between refreshes and app restarts.
+ */
+export interface StorageAPI {
+  /** Get a stored value */
+  get(key: string): unknown;
+
+  /** Store a value */
+  set(key: string, value: unknown): void;
+}
+
+/**
+ * Configuration API
+ *
+ * Access user-configured values defined in manifest.yaml.
+ */
+export interface ConfigAPI {
+  /** Get a config value by key */
+  get(key: string): string | undefined;
+
+  /** Get all config values */
+  getAll(): Record<string, string>;
+}
+
+/**
+ * WebSocket API for real-time connections
+ */
+export interface WebSocketAPI {
+  /** Connect to a WebSocket server */
+  connect(url: string, callbacks: WebSocketCallbacks): Promise<WebSocketConnection>;
+}
+
+/**
+ * WebSocket event callbacks
+ */
+export interface WebSocketCallbacks {
+  /** Called when connection is established */
+  onConnect?: (ws: WebSocketConnection) => void;
+
+  /** Called when a message is received */
+  onMessage?: (data: string) => void;
+
+  /** Called when an error occurs */
+  onError?: (error: string) => void;
+
+  /** Called when connection is closed */
+  onClose?: (code: number) => void;
+}
+
+/**
+ * WebSocket connection
+ */
+export interface WebSocketConnection {
+  /** Send a message */
+  send(message: string): Promise<void>;
+
+  /** Close the connection */
+  close(): void;
+}
+
+/**
+ * Source methods returned by your source function
+ */
+export interface SourceMethods {
+  /** Called on startup and periodically based on user settings */
+  refresh?: () => Promise<void> | void;
+
+  /** Called when source is stopped (for cleanup) */
+  stop?: () => Promise<void> | void;
+}

package/template/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "dist",
+    "rootDir": "src",
+    "declaration": false
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}