@ory/argus 0.4.0 → 0.5.0

package/assets/skills/ory-build-integration/SKILL.md

@@ -0,0 +1,108 @@
+---
+name: ory-build-integration
+description: Wire an Ory Network integration into your own application using the ory/integrates template patterns. Use when the user wants to add an Ory integration to their app — an Action webhook handler that fires during a flow, a Console/gateway config to validate Ory JWTs, or an Enterprise live-event-stream consumer — phrases like "wire up an Ory webhook", "add an Ory Action handler to my app", "react to Ory identity events", "validate Ory tokens at my gateway", "build an Ory integration in my project". For contributing an integration back to ory/integrates instead, use ory-contribute-integration.
+---
+
+# Build an Ory Integration Into Your App
+
+You are helping the user wire an Ory Network integration into **their own
+application**, reusing the proven patterns from the public `ory/integrates`
+repository. There is no contribution, registry, `Maintained by:`, or DCO concern
+here — you fetch the **runnable subset** of a template and adapt it in place.
+
+This skill carries the workflow. The template files live in
+`github.com/ory/integrates` (branch `main`); fetch the ones you need so they stay
+current.
+
+> **Precondition:** `ory/integrates` must be reachable (public repo). If a fetch
+> fails, tell the user and stop — do not fabricate handler code.
+
+## Step 1 — Determine the type and app context
+
+Pick the integration type from intent; ask directly if unclear.
+
+| Signal from the user | Type |
+|---|---|
+| Transform/enrich an identity at registration; gate or react to a flow **synchronously**; call a vendor API during an Ory flow | `webhook` |
+| Validate Ory JWTs at a gateway; **Console-only** config; no handler code | `config` |
+| React to events **asynchronously**; Ory **Enterprise** Live Event Stream consumer | `http-event` |
+
+Also establish: the app's framework/runtime, where the handler will live, and how
+it's deployed (these decide where you write files and how you mount the route).
+
+## Step 2 — Fetch the runnable subset
+
+Pull only the files the user needs from `_examples/_template-<type>/`. Prefer raw
+fetch so you don't clone the whole repo into the user's project.
+
+**Raw file fetch** (base URL
+`https://raw.githubusercontent.com/ory/integrates/main/_examples/_template-<type>/`):
+
+```bash
+BASE=https://raw.githubusercontent.com/ory/integrates/main/_examples/_template-webhook
+mkdir -p ory-integration/webhook ory-integration/jsonnet
+curl -fsSL "$BASE/ory-actions.yaml"          -o ory-integration/ory-actions.yaml
+curl -fsSL "$BASE/jsonnet/identity.jsonnet"  -o ory-integration/jsonnet/identity.jsonnet
+curl -fsSL "$BASE/webhook/server.ts"         -o ory-integration/webhook/server.ts
+curl -fsSL "$BASE/webhook/package.json"      -o ory-integration/webhook/package.json
+curl -fsSL "$BASE/webhook/tsconfig.json"     -o ory-integration/webhook/tsconfig.json
+curl -fsSL "$BASE/webhook/.env.example"      -o ory-integration/webhook/.env.example
+```
+
+**Sparse checkout** (if the user prefers a git copy to diff against):
+
+```bash
+git clone --depth 1 --filter=blob:none --sparse https://github.com/ory/integrates /tmp/ory-integrates
+git -C /tmp/ory-integrates sparse-checkout set _examples/_template-webhook
+# then copy the files you want out of /tmp/ory-integrates/_examples/_template-webhook
+```
+
+Runnable subset per type (skip `registry.entry.yaml.example`, the
+`Maintained by:` README, and lockfiles — `npm install` regenerates the lock):
+
+- **webhook** — `ory-actions.yaml`, `jsonnet/identity.jsonnet`,
+  `webhook/{server.ts, package.json, tsconfig.json, .env.example}`.
+- **config** — `ory-console-steps.md` (no code; it's a Console walkthrough).
+- **http-event** — `ory-event-stream.yaml`,
+  `webhook/{server.ts, idempotency.ts, package.json, tsconfig.json, .env.example}`.
+
+Adapt the fetched handler into the user's app: integrate the route into their
+existing server if they have one, or run the `webhook/` server standalone.
+
+## Step 3 — Wire it to the user's Ory project
+
+- **webhook** — deploy the handler, then create an Ory Action pointing at it using
+  `ory-actions.yaml` as the template (set `url` to the deployed handler, set the
+  `X-Webhook-Secret` value, and the matching `ORY_WEBHOOK_SECRET` in the
+  handler's `.env`). Adjust `jsonnet/identity.jsonnet` to the body shape the
+  handler expects. Apply via the Ory Console or the Ory CLI.
+- **config** — follow `ory-console-steps.md`: configure the vendor side, then the
+  Ory Console (gateway/JWT validation, provider config, etc.). No code to deploy.
+- **http-event** (Enterprise) — deploy the handler, then configure the
+  event-stream target from `ory-event-stream.yaml` (URL with embedded Basic Auth;
+  set `BASIC_AUTH_USER` / `BASIC_AUTH_PASSWORD` in `.env` to match) and the event
+  filter. Keep the `idempotency.ts` dedupe wired up — delivery is at-least-once.
+
+Always verify the signature/secret path: webhook uses the `X-Webhook-Secret`
+header; http-event uses HTTP Basic Auth embedded in the configured URL.
+
+## Step 4 — Test locally
+
+Stand up Ory and exercise the flow locally before pointing at production:
+
+- Use {{REF_LOCAL_DEV}} to run a local Ory stack (Kratos / Keto / Hydra +
+  gateway), then trigger the relevant flow and confirm the handler fires.
+- Use {{REF_AUTH_SETUP}} when the app also needs Ory project / SDK setup wired up.
+
+For a webhook, hit `GET /health` on the handler, then run the Ory flow and check
+the handler logs. For http-event, emit a test event and confirm both the dedupe
+and the downstream side effect.
+
+## What this skill does NOT do
+
+- It does not create a contribution to `ory/integrates` (no `registry.entry.yaml`,
+  `Maintained by:`, SPDX, or DCO) — use `ory-contribute-integration` for that.
+- It does not invent handler code — it fetches the real templates from
+  `ory/integrates`.
+- It does not deploy to the user's infrastructure or modify their Ory project
+  without confirmation.

package/assets/skills/ory-contribute-integration/SKILL.md

@@ -0,0 +1,164 @@
+---
+name: ory-contribute-integration
+description: Author a new Ory Network integration as a contribution to the public ory/integrates repository. Use when the user wants to contribute an integration back to Ory, add an entry to the Ory integrations registry/catalog, open a PR against ory/integrates, or publish a reusable integration for others — phrases like "contribute an Ory integration", "add my integration to ory/integrates", "submit a webhook integration to Ory", "get my integration into the registry". For wiring an integration into your own app instead, use ory-build-integration.
+---
+
+# Contribute an Integration to ory/integrates
+
+You are helping the user author a new integration and contribute it back to the
+public `ory/integrates` repository ("Sample code and reference configuration for
+integrating Ory Network with third-party products"). The deliverable is a pull
+request against `github.com/ory/integrates`.
+
+This skill carries the workflow. The **template files** live in the repo itself —
+fetch them from `github.com/ory/integrates` (branch `main`) rather than
+reproducing them, so they never drift.
+
+> **Precondition:** `ory/integrates` must be reachable (it is a public repo). If
+> `gh repo view ory/integrates` or a fetch of a template file fails, tell the
+> user the repo is unreachable and stop — do not fabricate template contents.
+
+## Step 0 — Open the "New integration" issue first
+
+Ory asks contributors to open a **New integration** issue before the PR, so scope
+is confirmed and the work isn't already in flight. Remind the user to do this
+(GitHub → `ory/integrates` → Issues → "New integration" template) and capture the
+issue number for the PR.
+
+## Step 1 — Get a checkout and pick the category
+
+The contribution workflow happens inside a checkout of the repo:
+
+```bash
+gh repo clone ory/integrates
+cd integrates
+```
+
+(or a fork, if the user will PR from their own remote.) Then choose the
+**category folder** the integration belongs in — it must match an existing
+top-level directory (`crm/`, `api-gateways/`, `identity-verification/`, `mfa/`,
+`enterprise-sso/`, …). List them with `ls -d */ | grep -v _examples`.
+
+## Step 2 — Determine the integration type
+
+Every integration is one of three types. Infer from intent; if unclear, ask
+directly.
+
+| Signal from the user | Type | Template |
+|---|---|---|
+| Transform/enrich an identity at registration; gate or react to a self-service flow **synchronously**; call a vendor API during an Ory flow | `webhook` | `_examples/_template-webhook/` |
+| Validate Ory JWTs at a gateway; **Console-only** setup; no handler code | `config` | `_examples/_template-config/` |
+| React to events **asynchronously**; Ory Network **Enterprise** Live Event Stream consumer | `http-event` | `_examples/_template-http-event/` |
+
+## Step 3 — Copy the template into the category folder
+
+From the repo root, copy the whole template directory to
+`<category>/<integration-slug>` (slug is lowercase, hyphenated, matches the dir
+name):
+
+```bash
+cp -R _examples/_template-webhook crm/<integration-slug>      # webhook
+# or _examples/_template-config / _examples/_template-http-event
+```
+
+Each template ships these files (confirm with `ls -R <category>/<integration-slug>`):
+
+- **webhook** — `README.md`, `ory-actions.yaml`, `jsonnet/identity.jsonnet`,
+  `registry.entry.yaml.example`, and a runnable `webhook/` (`server.ts`,
+  `package.json`, `package-lock.json`, `tsconfig.json`, `.env.example`).
+- **config** — `README.md`, `ory-console-steps.md`,
+  `registry.entry.yaml.example`.
+- **http-event** — `README.md`, `ory-event-stream.yaml`,
+  `registry.entry.yaml.example`, and a runnable `webhook/` (`server.ts`,
+  `idempotency.ts`, `package.json`, `package-lock.json`, `tsconfig.json`,
+  `.env.example`).
+
+The copied files are the source of truth — read them and fill in every
+`<placeholder>` and `<!-- comment -->`.
+
+## Step 4 — Fill out the integration
+
+1. **README.md** — replace `<Integration Name>`, set the `Maintained by:` line
+   (`Ory Engineering`, `Community contributors`, or the user's `@handle`), and
+   complete: what it does, use case, prerequisites, deploy steps, **Ory Console
+   configuration**, troubleshooting. No vendor marketing — factual wiring only.
+2. **Code / config for the type** (see per-type notes below).
+3. **registry.entry.yaml** — rename `registry.entry.yaml.example` →
+   `registry.entry.yaml` and fill in every field (`name`, `displayName`,
+   `vendor`, `category`, `type`, `maintainedBy`, `description`, `useCase`,
+   `coreFunctionality`, `oryMechanism`, `protocol`, `status`; http-event also
+   needs `subscribedEvents`). The field comments in the file enumerate the
+   allowed enum values.
+4. **Apache-2.0 SPDX header** at the top of every source file you ship, e.g.
+   `// SPDX-License-Identifier: Apache-2.0`.
+
+### webhook specifics
+- `ory-actions.yaml` is the Ory Action hook config (a `web_hook` with an
+  `X-Webhook-Secret` `api_key` auth header). Point `url` at the deployed handler
+  and set the shared secret.
+- `jsonnet/identity.jsonnet` is the request-body template — adjust to the shape
+  your handler expects.
+- The `webhook/` server must run (`cd webhook && cp .env.example .env && npm
+  install && npm start`); it exposes `GET /health` and the `POST` target.
+  `ORY_WEBHOOK_SECRET` in `.env` must match the secret in `ory-actions.yaml`.
+
+### config specifics
+- No code. Write a real `ory-console-steps.md`: vendor-side setup, the exact Ory
+  Console navigation, the fields to configure, a test, and troubleshooting. A
+  README-only contribution with no real console steps will be rejected.
+
+### http-event specifics
+- `ory-event-stream.yaml` configures the Ory-side event target (URL with embedded
+  Basic Auth) and the event filter. List the consumed events under both the YAML
+  `events:` and the registry `subscribedEvents:`.
+- The `webhook/` handler authenticates with HTTP Basic Auth, dedupes by SHA-256
+  of the body (`idempotency.ts`) because delivery is at-least-once, and always
+  returns 200. Live event streams are an **Enterprise** feature — say so in the
+  README.
+
+## Step 5 — Regenerate the registry
+
+From the repo root:
+
+```bash
+cd scripts && npm install && cd ..
+node scripts/build-registry.js
+```
+
+This rewrites the top-level `registry.yaml` from every `registry.entry.yaml`.
+Commit the regenerated `registry.yaml` along with your integration.
+
+## Step 6 — Open the PR (DCO + checklist)
+
+Walk the CONTRIBUTING checklist before opening the PR:
+
+- [ ] Integration is in the correct category folder.
+- [ ] `README.md` covers what it does, prerequisites, deploy, Console config,
+      troubleshooting, and a `Maintained by:` line.
+- [ ] Type deliverables present: webhook → `ory-actions.yaml` + `jsonnet/` +
+      runnable `webhook/`; config → real `ory-console-steps.md`; http-event →
+      `ory-event-stream.yaml` + runnable `webhook/` + `subscribedEvents`.
+- [ ] `registry.entry.yaml` filled and `registry.yaml` regenerated.
+- [ ] Apache-2.0 SPDX header in each source file.
+- [ ] **DCO sign-off on every commit** — `git commit -s`.
+
+```bash
+git checkout -b add-<integration-slug>-integration
+git add <category>/<integration-slug> registry.yaml
+git commit -s -m "Add <Integration Name> integration"
+git push -u origin add-<integration-slug>-integration
+gh pr create --repo ory/integrates --title "Add <Integration Name> integration" \
+  --body "Closes #<issue-number>. <summary>"
+```
+
+Expect review questions about Ory Network compatibility, webhook security
+(signature verification, secret handling), and README clarity.
+
+## What this skill does NOT do
+
+- It does not wire an integration into the user's own application — use
+  `ory-build-integration` for that (no registry/DCO).
+- It does not run `build-registry.js` or open the PR without confirmation; it
+  guides, the user executes.
+- It does not invent template contents — it reads the real files from
+  `ory/integrates`.

package/dist/skills.d.ts

@@ -1,7 +1,8 @@
 /**
  * Canonical Ory agent skills and commands.
  *
- * The skill playbooks (auth-setup, login-flow, social-login, local-dev) and the
+ * The skill playbooks (auth-setup, login-flow, social-login, local-dev,
+ * permissions-onboarding, contribute-integration, build-integration) and the
  * local-stack commands (local-up, local-down) live once, as token-bearing
  * templates under `packages/core/assets/`. Every harness plugin renders them
  * through {@link renderOrySkills} / {@link renderOryCommands}, substituting the
@@ -50,7 +51,7 @@ export interface RenderProfileOptions {
     packageName: string;
 }
 /**
- * Render the four guide skills for a harness as `SKILL.md` documents.
+ * Render the guide skills for a harness as `SKILL.md` documents.
  */
 export declare function renderOrySkills(harness: string, opts: RenderProfileOptions): RenderedSkill[];
 /**

package/dist/skills.js

@@ -2,7 +2,8 @@
 /**
  * Canonical Ory agent skills and commands.
  *
- * The skill playbooks (auth-setup, login-flow, social-login, local-dev) and the
+ * The skill playbooks (auth-setup, login-flow, social-login, local-dev,
+ * permissions-onboarding, contribute-integration, build-integration) and the
  * local-stack commands (local-up, local-down) live once, as token-bearing
  * templates under `packages/core/assets/`. Every harness plugin renders them
  * through {@link renderOrySkills} / {@link renderOryCommands}, substituting the
@@ -70,6 +71,16 @@ const SKILL_SOURCES = [
         name: "ory-permissions-onboarding",
         file: "skills/permissions-onboarding/SKILL.md",
     },
+    {
+        id: "contribute-integration",
+        name: "ory-contribute-integration",
+        file: "skills/ory-contribute-integration/SKILL.md",
+    },
+    {
+        id: "build-integration",
+        name: "ory-build-integration",
+        file: "skills/ory-build-integration/SKILL.md",
+    },
 ];
 const COMMAND_SOURCES = [
     {
@@ -177,7 +188,7 @@ function parseFrontmatter(markdown) {
 }
 // ─── Public render API ──────────────────────────────────────────────
 /**
- * Render the four guide skills for a harness as `SKILL.md` documents.
+ * Render the guide skills for a harness as `SKILL.md` documents.
  */
 function renderOrySkills(harness, opts) {
     const profile = buildProfile(harness, opts);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ory/argus",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Ory Argus: the core API for building authentication, authorization, and audit into AI agent harness plugins, extensions, and custom integrations",
   "license": "Apache-2.0",
   "homepage": "https://ory.com",