create-glanceway-source 1.0.0 → 1.2.0

package/{template → templates}/src/types.ts

@@ -3,24 +3,27 @@
  *
  * The main API object passed to your source function.
  */
-export interface GlancewayAPI {
+export interface GlancewayAPI<TConfig extends Record<string, unknown> = Record<string, unknown>> {
   /** Send information items to Glanceway for display */
   emit(items: InfoItem[]): void;
 
   /** Make HTTP requests */
-  fetch(url: string, options?: FetchOptions): Promise<FetchResponse>;
+  fetch<T>(url: string, options?: FetchOptions): Promise<FetchResponse<T>>;
 
   /** Log messages for debugging */
-  log(level: 'info' | 'error' | 'warn' | 'debug', message: string): void;
+  log(level: "info" | "error" | "warn" | "debug", message: string): void;
 
   /** Persistent key-value storage */
   storage: StorageAPI;
 
   /** Access user-configured values */
-  config: ConfigAPI;
+  config: ConfigAPI<TConfig>;
 
   /** Create WebSocket connections */
   websocket: WebSocketAPI;
+
+  /** Current Glanceway app version */
+  appVersion: string;
 }
 
 /**
@@ -28,7 +31,7 @@ export interface GlancewayAPI {
  */
 export interface InfoItem {
   /** Unique identifier for the item */
-  id: string | number;
+  id: string;
 
   /** Main display text */
   title: string;
@@ -48,7 +51,7 @@ export interface InfoItem {
  */
 export interface FetchOptions {
   /** HTTP method (default: GET) */
-  method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+  method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
 
   /** Request headers */
   headers?: Record<string, string>;
@@ -63,7 +66,7 @@ export interface FetchOptions {
 /**
  * HTTP response
  */
-export interface FetchResponse {
+export interface FetchResponse<T> {
   /** True if status code is 200-299 */
   ok: boolean;
 
@@ -77,7 +80,10 @@ export interface FetchResponse {
   text: string;
 
   /** Parsed JSON (if response is valid JSON) */
-  json?: unknown;
+  json?: T;
+
+  /** Error message if request failed */
+  error?: string;
 }
 
 /**
@@ -87,10 +93,10 @@ export interface FetchResponse {
  */
 export interface StorageAPI {
   /** Get a stored value */
-  get(key: string): unknown;
+  get(key: string): string | undefined;
 
   /** Store a value */
-  set(key: string, value: unknown): void;
+  set(key: string, value: string): void;
 }
 
 /**
@@ -98,12 +104,12 @@ export interface StorageAPI {
  *
  * Access user-configured values defined in manifest.yaml.
  */
-export interface ConfigAPI {
+export interface ConfigAPI<TConfig extends Record<string, unknown> = Record<string, unknown>> {
   /** Get a config value by key */
-  get(key: string): string | undefined;
+  get<K extends keyof TConfig>(key: K): TConfig[K];
 
   /** Get all config values */
-  getAll(): Record<string, string>;
+  getAll(): TConfig;
 }
 
 /**
@@ -111,7 +117,10 @@ export interface ConfigAPI {
  */
 export interface WebSocketAPI {
   /** Connect to a WebSocket server */
-  connect(url: string, callbacks: WebSocketCallbacks): Promise<WebSocketConnection>;
+  connect(
+    url: string,
+    callbacks: WebSocketCallbacks,
+  ): Promise<WebSocketConnection>;
 }
 
 /**
@@ -146,7 +155,7 @@ export interface WebSocketConnection {
  * Source methods returned by your source function
  */
 export interface SourceMethods {
-  /** Called on startup and periodically based on user settings */
+  /** Called periodically based on user settings (NOT called on initial load) */
   refresh?: () => Promise<void> | void;
 
   /** Called when source is stopped (for cleanup) */

package/{template → templates}/tsconfig.json

@@ -8,9 +8,8 @@
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
     "outDir": "dist",
-    "rootDir": "src",
-    "declaration": false
+    "rootDir": "."
   },
-  "include": ["src/**/*"],
+  "include": ["src/**/*", "scripts/**/*"],
   "exclude": ["node_modules", "dist"]
 }

package/template/manifest.yaml.ejs

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

package/template/package.json.ejs

@@ -1,14 +0,0 @@
-{
-  "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

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