@jimhoyd/urlcode 0.3.0

package/starters/default/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

package/starters/default/Makefile

@@ -0,0 +1,30 @@
+.DEFAULT_GOAL := help
+
+# Install the runtime separately, or override: URLCODE='node /path/to/urlcode/src/cli.js'
+URLCODE ?= urlcode
+HOST ?= 127.0.0.1
+PORT ?= 3000
+
+.PHONY: help dev serve validate test doctor
+help:
+	@echo "make dev       Run this app with reload and .env.local"
+	@echo "make validate  Validate this app and its local bindings"
+	@echo "make test      Run this app's HTTP assertions"
+	@echo "make serve     Run a fixed snapshot, without local dotenv"
+	@echo "make doctor    Show runtime/platform details"
+	@echo "Options: PORT=3001 HOST=127.0.0.1 URLCODE=urlcode"
+
+dev:
+	$(URLCODE) dev --project . --host "$(HOST)" --port "$(PORT)"
+serve:
+	$(URLCODE) serve --project . --host "$(HOST)" --port "$(PORT)"
+validate:
+	$(URLCODE) validate --local --project .
+test:
+	$(URLCODE) test --project .
+doctor:
+	$(URLCODE) doctor
+
+.PHONY: routes audit benchmark
+routes audit benchmark:
+	$(URLCODE) $@ --project . $(ARGS)

package/starters/default/README.md

@@ -0,0 +1,34 @@
+# Your URLCode project
+
+One starter: a URL that runs your function, and a regular redirect.
+Created with `urlcode init ../my-links`. No template choice is needed.
+
+```sh
+urlcode dev
+# In another terminal:
+urlcode test
+urlcode audit --expect-routes 2
+urlcode benchmark --requests 1000 --concurrency 2
+```
+
+Visit http://127.0.0.1:3000/hello/Ada or http://127.0.0.1:3000/go.
+`urlcode.yaml` loads `routes/functions.yaml` and `routes/marketing/links.yaml`.
+Organize those files however you like; references are relative to the project root.
+The function route uses `middleware/headers.mjs` to add a response header around
+`await next()`. Edit or reuse it on other routes as needed.
+GET/HEAD, redirect 302 and no-store defaults keep YAML short. Valid edits reload.
+
+This app uses the runtime you installed separately (compatible with 0.1.0).
+Without a global install, invoke `node /path/to/urlcode/src/cli.ts` instead of
+`urlcode`. Optional Make shortcuts accept `URLCODE='node /path/to/urlcode/src/cli.ts'`.
+For a cloneable project with a pinned npm runtime dependency, use
+[urlcode-template](https://github.com/jimhoyd-com/urlcode-template). Both start
+with the same two route examples. No runtime fork or provider account is needed.
+
+Keep this app in your own Git repository. Secrets stay in ignored `.env.local`
+or provider environment values, with external operator policy for function grants.
+See [security](https://github.com/jimhoyd-com/urlcode/blob/main/docs/FUNCTION-SECURITY.md)
+and [readiness](https://github.com/jimhoyd-com/urlcode/blob/main/docs/READINESS.md).
+Add routes and assertions as your app grows; update the expected count deliberately.
+URLCode is licensed under the Apache License 2.0. `gitignore.template` is initializer packaging
+source and can be removed after `.gitignore` exists.

package/starters/default/functions/hello.mjs

@@ -0,0 +1,3 @@
+export default function hello(request, { args }) {
+  return Response.json({ message: `Hello, ${args.name}!` });
+}

package/starters/default/gitignore.template

@@ -0,0 +1,8 @@
+node_modules/
+.env
+.env.*
+!.env.example
+.urlcode/
+.urlcode-edit-*/
+urlcode.yaml.lock
+.DS_Store

package/starters/default/middleware/headers.mjs

@@ -0,0 +1,6 @@
+// Reusable logic around a route: run downstream, then add a response header.
+export default async function headers(request, context, next) {
+  const response = await next();
+  response.headers.set('x-example-middleware', 'active');
+  return response;
+}

package/starters/default/routes/functions.yaml

@@ -0,0 +1,20 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/jimhoyd-com/urlcode/669632fb4f188f293a0f622847f87ee019c0627f/schemas/urlcode.schema.json
+# File locations do not change route paths. GET/HEAD are the default methods.
+version: "1"
+routes:
+  # Your code runs when this URL is requested.
+  /hello/{name}:
+    parameters:
+      - name: name
+        in: path
+        required: true
+        schema: {type: string, minLength: 1, maxLength: 80}
+    middleware:
+      - source: middleware/headers.mjs
+    function:
+      source: functions/hello.mjs
+      args:
+        name: {from: path, name: name}
+    response:
+      headers:
+        X-Powered-By: URLCode

package/starters/default/routes/marketing/links.yaml

@@ -0,0 +1,7 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/jimhoyd-com/urlcode/669632fb4f188f293a0f622847f87ee019c0627f/schemas/urlcode.schema.json
+version: "1"
+routes:
+  # A regular redirect needs no custom code.
+  /go:
+    redirect:
+      url: https://example.com

package/starters/default/starter.json

@@ -0,0 +1,5 @@
+{
+  "compatibleRuntime": "0.1.0",
+  "runtimeRepository": "https://github.com/jimhoyd-com/urlcode",
+  "templateRepository": "https://github.com/jimhoyd-com/urlcode-template"
+}

package/starters/default/tests/requests.json

@@ -0,0 +1,56 @@
+[
+  {
+    "path": "/hello/Ada",
+    "status": 200,
+    "expectBody": "{\"message\":\"Hello, Ada!\"}",
+    "expectHeaders": {
+      "x-powered-by": "URLCode",
+      "cache-control": "no-store",
+      "x-example-middleware": "active"
+    }
+  },
+  {
+    "path": "/hello/Ada",
+    "method": "HEAD",
+    "status": 200,
+    "expectBody": "",
+    "expectHeaders": {
+      "x-example-middleware": "active"
+    }
+  },
+  {
+    "path": "/go",
+    "status": 302,
+    "expectHeaders": {
+      "location": "https://example.com/"
+    }
+  },
+  {
+    "path": "/go",
+    "method": "POST",
+    "status": 405,
+    "expectHeaders": {
+      "allow": "GET, HEAD"
+    }
+  },
+  {
+    "path": "/missing",
+    "status": 404
+  },
+  {
+    "path": "/hello/Ada",
+    "method": "POST",
+    "status": 405,
+    "expectHeaders": {
+      "allow": "GET, HEAD"
+    }
+  },
+  {
+    "path": "/hello/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+    "status": 400
+  },
+  {
+    "path": "/hello/%ZZ",
+    "status": 400
+  }
+]

package/starters/default/urlcode.yaml

@@ -0,0 +1,8 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/jimhoyd-com/urlcode/669632fb4f188f293a0f622847f87ee019c0627f/schemas/urlcode.schema.json
+# Organize files however you like; list their paths from this project root.
+version: "1"
+dynamicLinks: false
+includes:
+  - routes/functions.yaml
+  - routes/marketing/links.yaml
+routes: {}