@canopy-io/node 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @canopy-io/node
 
+## 0.7.0
+
+### Minor Changes
+
+- b336767: **Breaking:** the authorizer's cache window is capped at five minutes. `LocalAuthorizer`'s `ttlMs` (and `CanopyModule`'s `authorizationTtlMs`) above `300_000`, below `0`, or not a number now throws a `RangeError` when the authorizer is created. The window is how long a revoked user keeps access, so a longer one is refused rather than honoured. The default (60 seconds) and `0` (read fresh on every check) are unchanged. `MAX_TTL_MS` is exported.
+- b336767: **Breaking:** `TokenVerifier` no longer defaults its issuer. Every Canopy Environment is its own issuer with its own signing keys (`https://auth.canopy-io.com/environments/<id>`), so the old default, the bare hosted origin, rejected every identity token. Pass `environmentId`, or `issuer` on a custom auth domain or self-hosted instance; the constructor throws with neither or both. The key set is read from the issuer's own `/.well-known/jwks.json`.
+
+  `CanopyModule` now requires `verify` with `environmentId` (or `issuer`), since it builds the verifier at startup.
+
+  The generated types follow the published API, which now includes OAuth client management (`/api/v1/oauth-clients`); those routes are typed but not wrapped as a resource, like API key management.
+
 ## 0.6.0
 
 ### Minor Changes

package/README.md

@@ -110,8 +110,16 @@ rather than ignored when you have not said which client you are:
 new TokenVerifier({ audience: process.env.CANOPY_OAUTH_CLIENT_ID });
 ```
 
-Self-hosted instances set `issuer`. Getting it wrong fails closed: tokens are
-rejected, never mistakenly accepted.
+Every Environment is its own issuer, so name yours:
+
+```ts
+new TokenVerifier({ environmentId: process.env.CANOPY_ENVIRONMENT_ID });
+```
+
+On a custom auth domain or a self-hosted instance, set `issuer` instead
+(`https://auth.acme.com`, or `<origin>/environments/<id>`). The constructor
+throws with neither. Getting it wrong fails closed: tokens are rejected, never
+mistakenly accepted.
 
 With an Environment's **organizations** container on, an identity token also
 names the organization the session is acting in and the one role held there. Read the pair through `orgContext` rather than off the raw claims —
@@ -227,8 +235,9 @@ everything beneath it_, so the roots are never expanded into their descendants.
 
 Both are held for at most 60 seconds, which is the delay between an access
 change and it taking effect, including a moved node. Set `ttlMs` to change it,
-knowing that shortening it below the gap between a user's requests saves
-nothing — every request then finds the cache expired and refetches.
+up to five minutes (`300_000`); a longer value throws when the authorizer is
+created. Shortening it below the gap between a user's requests saves nothing:
+every request then finds the cache expired and refetches.
 
 `canopy.permissions.evaluate` remains for a decision with no staleness at all.
 

package/dist/index.cjs

@@ -84,6 +84,15 @@ function isCanopyTokenError(error) {
   return error instanceof Error && error.name === "CanopyTokenError";
 }
 
+// src/strings.ts
+function withoutTrailingSlashes(value) {
+  let end = value.length;
+  while (end > 0 && value[end - 1] === "/") {
+    end -= 1;
+  }
+  return value.slice(0, end);
+}
+
 // src/client.ts
 function isCursorPagination(pagination) {
   return "next_cursor" in pagination;
@@ -108,7 +117,7 @@ var CanopyClient = class {
         "CanopyClient requires either `apiKey` (server-to-server) or `accessToken` (a user or identity JWT)."
       );
     }
-    this.baseUrl = (options.baseUrl ?? DEFAULT_BASE_URL).replace(/\/+$/, "");
+    this.baseUrl = withoutTrailingSlashes(options.baseUrl ?? DEFAULT_BASE_URL);
     this.timeoutMs = options.timeoutMs ?? DEFAULT_TIMEOUT_MS;
     this.maxRetries = options.maxRetries ?? DEFAULT_MAX_RETRIES;
     this.maxBackoffMs = options.maxBackoffMs ?? DEFAULT_MAX_BACKOFF_MS;
@@ -1109,6 +1118,7 @@ var Canopy = class {
 
 // src/authorizer.ts
 var DEFAULT_TTL_MS = 6e4;
+var MAX_TTL_MS = 3e5;
 var MAX_WALK_DEPTH = 256;
 var LocalAuthorizer = class {
   client;
@@ -1135,6 +1145,11 @@ var LocalAuthorizer = class {
   constructor(client, options = {}) {
     this.client = client;
     this.ttlMs = options.ttlMs ?? DEFAULT_TTL_MS;
+    if (!Number.isFinite(this.ttlMs) || this.ttlMs < 0 || this.ttlMs > MAX_TTL_MS) {
+      throw new RangeError(
+        `ttlMs must be between 0 and ${MAX_TTL_MS} (five minutes); got ${String(this.ttlMs)}. It is how long a revoked user keeps access, so it is capped.`
+      );
+    }
     this.now = options.now ?? (() => Date.now());
     this.readOptions = {
       ...options.timeoutMs === void 0 ? {} : { timeoutMs: options.timeoutMs },
@@ -1324,12 +1339,29 @@ var LocalAuthorizer = class {
 };
 
 // src/verify.ts
-var DEFAULT_ISSUER = "https://auth.canopy-io.com";
+var HOSTED_ORIGIN = "https://auth.canopy-io.com";
 var DEFAULT_JWKS_CACHE_MAX_AGE_MS = 10 * 60 * 1e3;
 var DEFAULT_JWKS_MIN_REFETCH_INTERVAL_MS = 30 * 1e3;
 var DEFAULT_JWKS_TIMEOUT_MS = 5e3;
 var PRINCIPAL_TYPES = /* @__PURE__ */ new Set(["user", "identity", "api_key", "platform"]);
 var DEFAULT_CLOCK_TOLERANCE_SEC = 60;
+function resolveIssuer(options) {
+  const { environmentId, issuer } = options;
+  if (environmentId && issuer) {
+    throw new TypeError(
+      "TokenVerifier takes environmentId or issuer, not both."
+    );
+  }
+  if (issuer) {
+    return withoutTrailingSlashes(issuer);
+  }
+  if (environmentId) {
+    return `${HOSTED_ORIGIN}/environments/${environmentId}`;
+  }
+  throw new TypeError(
+    "TokenVerifier needs environmentId (the Environment your tokens come from) or, on a custom auth domain or self-hosted instance, issuer."
+  );
+}
 function orgContext(claims) {
   const { org_id, org_role } = claims;
   if (typeof org_id !== "string" || org_id === "" || typeof org_role !== "string" || org_role === "") {
@@ -1374,7 +1406,7 @@ var TokenVerifier = class {
   /** In-flight fetch, so a burst of requests triggers one call, not N. */
   inFlight = null;
   constructor(options = {}) {
-    this.issuer = (options.issuer ?? DEFAULT_ISSUER).replace(/\/+$/, "");
+    this.issuer = resolveIssuer(options);
     this.audience = options.audience;
     this.jwksUri = options.jwksUri ?? `${this.issuer}/.well-known/jwks.json`;
     this.jwksCacheMaxAgeMs = options.jwksCacheMaxAgeMs ?? DEFAULT_JWKS_CACHE_MAX_AGE_MS;
@@ -1661,6 +1693,7 @@ exports.CanopyError = CanopyError;
 exports.CanopyTokenError = CanopyTokenError;
 exports.Identities = Identities;
 exports.LocalAuthorizer = LocalAuthorizer;
+exports.MAX_TTL_MS = MAX_TTL_MS;
 exports.Organizations = Organizations;
 exports.Paginator = Paginator;
 exports.Permissions = Permissions;