first commit

Author: juanmrad

.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version-file: '.nvmrc'
+          check-latest: true
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build

.github/workflows/publish.yml

@@ -0,0 +1,26 @@
+name: Publish Package
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  id-token: write  # Required for OIDC
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v6
+        with:
+          node-version-file: '.nvmrc'
+          check-latest: true
+          cache: 'npm'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish

.gitignore

@@ -0,0 +1,36 @@
+# Dependencies
+node_modules/
+
+# Build output
+dist/
+
+# Environment
+.env
+.env.*
+!.env.example
+
+# Logs and debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# OS
+.DS_Store
+Thumbs.db
+
+# IDE / editor
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# Optional npm cache
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# TypeScript incremental
+*.tsbuildinfo

.nvmrc

@@ -0,0 +1 @@
+24

README.md

@@ -0,0 +1,87 @@
+# @roostorg/coop-integration-example
+
+Example [COOP](https://github.com/roostorg/coop) integration plugin. Reference repository showing how to build a custom integration and signals for use in COOP.
+
+- **Integration config** – saving and loading per-org config (e.g. “True percentage”)
+- **Routing rules** – using the plugin signal in conditions
+- **Automated enforcement** – the same signal in enforcement rules
+
+## What it provides
+
+- **Integration:** `COOP_INTEGRATION_EXAMPLE`
+- **Signal 1 – Random Signal Selection** (`RANDOM_SIGNAL_SELECTION`): Returns `true` or `false` at random. The probability (0–100%) comes from the org’s integration config (“True percentage”). Set e.g. `70` in Org settings → Integrations; the signal returns `true` about 70% of the time. Use this to test config saving and boolean conditions.
+- **Signal 2 – Random Score** (`RANDOM_SCORE`): Returns a random number between 0 and 1. No integration config needed. In the rule builder you set a **threshold** (e.g. `0.5`) and choose **above** or **below**. Use this to test numeric score conditions (e.g. “score ≥ 0.5” or “score < 0.3”).
+
+## Install
+
+**From this repo (development):**
+
+```bash
+git clone https://github.com/roostorg/coop-integration-example.git
+cd coop-integration-example
+npm install
+npm run build
+```
+
+**From npm:**
+
+```bash
+npm install @roostorg/coop-integration-example
+```
+
+## Configure in COOP
+
+In your COOP `integrations.config.json` (or `INTEGRATIONS_CONFIG_PATH`), add:
+
+**Local path (development):**  
+If you cloned this repo next to your COOP server directory, use a path relative to the server (e.g. from `server/`):
+
+```json
+{
+  "integrations": [
+    { "package": "../coop-integration-example", "enabled": true }
+  ]
+}
+```
+
+**From npm:**
+
+```json
+{
+  "integrations": [
+    { "package": "@roostorg/coop-integration-example", "enabled": true }
+  ]
+}
+```
+
+Restart the COOP server so it loads the plugin.
+
+## Use in the app
+
+1. **Org settings → Integrations** – you should see “COOP Integration Example”. Open it and set **True percentage (0–100)** (e.g. `70`) for Random Signal Selection. Save.
+2. **Rules (routing or enforcement)** – when adding a condition:
+   - **Random Signal Selection**: Pick that signal; the condition uses your configured percentage (true/false).
+   - **Random Score**: Pick “Random Score”, then set a **threshold** (e.g. `0.5`) and choose **above** or **below**. The rule compares the random score to your threshold.
+
+## Contract
+
+This package implements the COOP plugin contract from `@roostorg/types`:
+
+- **Default export:** `CoopIntegrationPlugin` with `manifest` and `createSignals(context)`.
+- **Manifest:** `id`, `name`, `version`, `requiresConfig`, `configurationFields`, `signalTypeIds`, `modelCard` (with required sections `modelDetails` and `technicalIntegration`).
+- **createSignals:** Returns two descriptors:
+  - `RANDOM_SIGNAL_SELECTION`: `run(input)` uses `context.getCredential(orgId)` for true percentage; returns `{ outputType: { scalarType: 'BOOLEAN' }, score: boolean }`.
+  - `RANDOM_SCORE`: `run()` returns `{ outputType: { scalarType: 'NUMBER' }, score: number }` in [0, 1]; no config. Threshold is set in the rule (above/below).
+
+## Publishing
+
+CI runs on push/PR (build only). To publish to npm:
+
+1. Create a [GitHub release](https://github.com/roostorg/coop-integration-example/releases) (tag e.g. `v1.0.1`). The **Publish to npm** workflow runs on release and runs `npm publish --access public`.
+2. Add **NPM_TOKEN** in this repo’s secrets (Settings → Secrets and variables → Actions): an npm [automation token](https://docs.npmjs.com/creating-and-viewing-access-tokens) with publish permission for `@roostorg/coop-integration-example`.
+
+You can also trigger **Publish to npm** manually from the Actions tab (workflow_dispatch).
+
+## License
+
+ISC

package-lock.json

@@ -0,0 +1,45 @@
+{
+  "name": "@roostorg/coop-integration-example",
+  "version": "1.0.0",
+  "description": "Example package to show how a custom integration and signal can be used in COOP this is meant to be a reference repository and provide basic determination",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "roost-example-logo.png",
+    "roost-example-with-background.png"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "coop",
+    "integration",
+    "plugin",
+    "example"
+  ],
+  "author": "Roostorg",
+  "license": "apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/roostorg/coop-integration-example.git"
+  },
+  "bugs": {
+    "url": "https://github.com/roostorg/coop-integration-example/issues"
+  },
+  "homepage": "https://github.com/roostorg/coop-integration-example#readme",
+  "peerDependencies": {
+    "@roostorg/types": ">=1.0.0"
+  },
+  "devDependencies": {
+    "@roostorg/types": "^1.1.1",
+    "typescript": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}