create-glanceway-source 1.1.0 → 1.3.0

package/README.md

@@ -53,7 +53,7 @@ Example prompts:
 cd my-source
 npm install
 
-# Build: compiles TypeScript, creates dist/latest.zip
+# Build: compiles source, creates dist/latest.gwsrc
 npm run build
 
 # Test: executes source with mock API, validates emitted items
@@ -63,15 +63,15 @@ npm run test
 npm run test -- --config API_TOKEN=xxx --config USERNAME=yyy
 ```
 
-The `dist/latest.zip` file is the importable source package.
+The `dist/latest.gwsrc` file is the importable source package.
 
 ## Importing into Glanceway
 
 1. Open **Glanceway**
 2. Go to **Sources**
 3. Click **Import from file**
-4. Select `dist/latest.zip`
+4. Select `dist/latest.gwsrc`
 
 ## Submitting to glanceway-sources
 
-To share your source with the community, [open an issue](https://github.com/codytseng/glanceway-sources/issues) on glanceway-sources with a link to your project repository.
+To share your source with the community, [open an issue](https://github.com/glanceway/glanceway-sources/issues) on glanceway-sources with a link to your project repository.

package/dist/index.js

@@ -100,7 +100,7 @@ tags: []
 # config:
 #   - key: API_TOKEN
 #     name: API Token
-#     type: secret           # string, number, boolean, secret, select, or list
+#     type: secret           # string, number, boolean, secret, select, list, or multiselect
 #     required: true
 #     description: Your API token
 #   - key: SORT
@@ -111,7 +111,17 @@ tags: []
 #     options:
 #       - hot
 #       - new
-#       - top
+#       - label: Top (All Time)  # options support label/value format
+#         value: top
+#   - key: CATEGORIES
+#     name: Categories
+#     type: multiselect      # like select but allows multiple choices
+#     options:
+#       - label: Technology
+#         value: tech
+#       - label: Science
+#         value: science
+#       - sports
 `;
     return manifest;
 }
@@ -168,13 +178,13 @@ function generateClaudeMd(options) {
 
 ## Project Overview
 
-Glanceway source: "${options.name}" by ${options.author}. This is a standalone TypeScript source for [Glanceway](https://glanceway.app), a macOS menu bar app that displays information items.
+Glanceway source: "${options.name}" by ${options.author}. This is a standalone JavaScript source for [Glanceway](https://glanceway.app), a macOS menu bar app that displays information items.
 
 ## Commands
 
 \`\`\`bash
 npm install          # Install dependencies
-npm run build        # Build source into dist/ (compile + zip)
+npm run build        # Build source into dist/ (compile + package)
 npm run test         # Test source (mock API execution + validation)
 \`\`\`
 
@@ -190,7 +200,7 @@ There is no test framework. Build the source to verify it compiles. There is no
 - \`src/index.ts\` — Source implementation (main logic)
 - \`src/types.ts\` — GlancewayAPI type definitions (do not modify)
 - \`manifest.yaml\` — Source metadata and config schema
-- \`scripts/build.ts\` — Build script (esbuild compile + zip)
+- \`scripts/build.ts\` — Build script (esbuild compile + package)
 - \`scripts/test.ts\` — Test script (mock API + validation)
 
 ## Source Development Constraints
@@ -275,7 +285,7 @@ if (response.ok && response.json) {
 
 ### api.config.get(key: string): unknown
 
-Get a user-configured value by key (defined in \`manifest.yaml\` config section). Returns \`string\` for most types, \`string[]\` for \`list\` type.
+Get a user-configured value by key (defined in \`manifest.yaml\` config section). Returns \`string\` for most types, \`string[]\` for \`list\` and \`multiselect\` types.
 
 ### api.config.getAll(): Record<string, unknown>
 
@@ -330,7 +340,7 @@ min_app_version: 1.2.0     # Optional: minimum Glanceway app version required
 config:                     # Optional: user-configurable values
   - key: API_TOKEN
     name: API Token
-    type: secret            # string, number, boolean, secret, select, or list
+    type: secret            # string, number, boolean, secret, select, list, or multiselect
     required: true
     description: Description shown to user
   - key: TAGS
@@ -346,12 +356,43 @@ config:                     # Optional: user-configurable values
     options:
       - hot
       - new
-      - top
+      - label: Top (All Time)  # options support label/value format
+        value: top
+  - key: CATEGORIES
+    name: Categories
+    type: multiselect       # like select but allows multiple choices (value type: string[])
+    options:
+      - label: Technology
+        value: tech
+      - label: Science
+        value: science
+      - sports
+\`\`\`
+
+\`select\` and \`multiselect\` options can be plain strings or label/value objects:
+
+\`\`\`yaml
+options:
+  - plain_value            # value = "plain_value", displayed as "plain_value"
+  - label: Display Name    # value = "actual_value", displayed as "Display Name"
+    value: actual_value
 \`\`\`
 
+### Config Field Types
+
+| Type          | Description                                          | Value type  |
+|---------------|------------------------------------------------------|-------------|
+| \`string\`      | Free-form text input                                 | \`string\`    |
+| \`number\`      | Numeric input                                        | \`number\`    |
+| \`boolean\`     | Toggle switch                                        | \`boolean\`   |
+| \`secret\`      | Stored in macOS Keychain                             | \`string\`    |
+| \`select\`      | Dropdown (requires \`options\` list)                   | \`string\`    |
+| \`list\`        | Multiple string values                               | \`string[]\`  |
+| \`multiselect\` | Multiple choice from options (like select but multi) | \`string[]\`  |
+
 ## Source Lifecycle
 
-TypeScript sources have two distinct phases:
+JavaScript sources have two distinct phases:
 
 1. **Start phase**: When the source is first loaded, the default export function (outer closure) runs. The app does **NOT** call \`refresh()\` at this point. Sources should perform their initial data fetch here by \`await\`ing their fetch function before returning.
 2. **Refresh phase**: On each scheduled refresh interval, the app calls \`refresh()\`. This is the only time \`refresh()\` is invoked.
@@ -386,7 +427,7 @@ export default async (api: GlancewayAPI<Config>): Promise<SourceMethods> => {
 - Always make full use of the \`subtitle\` field. If the API response contains summary, description, brief, or any descriptive text, map it to \`subtitle\` so users get maximum information at a glance.
 - **Maximize items per fetch.** The app does not paginate, so each fetch should retrieve as many items as the API allows without hurting performance. The hard upper limit is **500 items** — never exceed this.
 
-## TypeScript Source Code Conventions
+## Source Code Conventions
 
 ### File Structure Order
 
@@ -398,6 +439,8 @@ import type { GlancewayAPI, SourceMethods } from "./types";
 type Config = {
   API_TOKEN: string;
   TAGS: string[];
+  SORT: string;           // select → string
+  CATEGORIES: string[];   // multiselect → string[]
 };
 
 // 3. Helper functions (pure utilities, no api dependency)
@@ -454,11 +497,11 @@ After building (\`npm run build\`), import into Glanceway:
 1. Open Glanceway
 2. Go to Sources
 3. Click "Import from file"
-4. Select \`dist/latest.zip\`
+4. Select \`dist/latest.gwsrc\`
 
 ## Submitting to glanceway-sources
 
-To share your source with the community, [open an issue](https://github.com/codytseng/glanceway-sources/issues) on glanceway-sources with a link to your project repository.
+To share your source with the community, [open an issue](https://github.com/glanceway/glanceway-sources/issues) on glanceway-sources with a link to your project repository.
 `;
 }
 // ─── File Operations ───────────────────────────────────────────────────────

package/package.json

@@ -1,8 +1,13 @@
 {
   "name": "create-glanceway-source",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "Scaffold a standalone Glanceway source project",
   "type": "module",
+  "homepage": "https://github.com/glanceway/create-glanceway-source",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/glanceway/create-glanceway-source.git"
+  },
   "bin": {
     "create-glanceway-source": "dist/index.js"
   },

package/templates/scripts/build.ts

@@ -81,18 +81,18 @@ async function main() {
   fs.copyFileSync(manifestPath, distManifestPath);
   console.log("  Created dist/manifest.yaml");
 
-  // Create versioned zip
-  const versionedZipPath = path.join(DIST_DIR, `${version}.zip`);
-  await createZip(versionedZipPath, [
+  // Create versioned .gwsrc package
+  const versionedPath = path.join(DIST_DIR, `${version}.gwsrc`);
+  await createZip(versionedPath, [
     { name: "manifest.yaml", content: manifestContent },
     { name: "index.js", content: compiledJs },
   ]);
-  console.log(`  Created dist/${version}.zip`);
+  console.log(`  Created dist/${version}.gwsrc`);
 
-  // Create latest.zip
-  const latestZipPath = path.join(DIST_DIR, "latest.zip");
-  fs.copyFileSync(versionedZipPath, latestZipPath);
-  console.log("  Created dist/latest.zip");
+  // Create latest.gwsrc
+  const latestPath = path.join(DIST_DIR, "latest.gwsrc");
+  fs.copyFileSync(versionedPath, latestPath);
+  console.log("  Created dist/latest.gwsrc");
 
   console.log("\nBuild complete!");
 }

package/templates/scripts/test.ts

@@ -72,7 +72,7 @@ function resolveConfig(
     const override = overrides[entry.key];
 
     if (override !== undefined) {
-      if (entry.type === "list") {
+      if (entry.type === "list" || entry.type === "multiselect") {
         resolved[entry.key] = override.split(",").map((s) => s.trim());
       } else if (entry.type === "boolean") {
         resolved[entry.key] = override === "true" || override === "1";