@chipmobilesdk/rn-ai 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,125 @@
 # @chipmobilesdk/rn-ai
 
+## 0.5.0
+
+### Minor Changes
+
+- Every peer range has an upper bound, and no package declares a peer it does not use. ([#21](https://github.com/operationd8979/chip-mobile-sdk/pull/21))
+
+  A peer range is now a caret, a tilde or an explicit `<`, except for `react` and
+  `react-native`: an app brings exactly one of each, so a floor is the only useful thing
+  to say about them. Every other peer is a library the app installs beside us, and an
+  open `>=` was a promise about versions nobody had run — mmkv 3→4 lost entitlements and
+  pending purchases exactly that way.
+
+  **Four of the new ceilings exclude a version that is already published**, so an app
+  that took the open range at its word may now see a peer warning. The new bound is the
+  major this release is tested against, which is the thing the old range failed to say:
+
+  | Peer | Was | Now | Published above the ceiling |
+  |---|---|---|---|
+  | `react-native-app-auth` (rn-auth) | `>=8` | `^8.0.0` | 9.0.0 |
+  | `react-native-keychain` (rn-auth) | `>=10` | `^10.0.0` | 11.0.0 |
+  | `@op-engineering/op-sqlite` (rn-local-db) | `>=17.1.0` | `^17.1.0` | 18.x, 19.x |
+  | `@react-native-firebase/messaging` (rn-notification) | `>=26.0.0` | `^26.0.0` | 27.x |
+
+  The others — `react-native-vision-camera` `^5.1.1`, `react-native-svg` `^15.15.0`,
+  `react-native-unistyles` `^3.2.0`, `@dr.pogodin/react-native-fs` `^2.39.2`,
+  `react-native-quick-crypto` `^1.0.0`, `react-native-notify-kit` `^10.5.0`,
+  `react-native-localize` `^3.7.0`, `react-native-mmkv` `^4.0.0` — exclude nothing that
+  exists today. rn-payment's mmkv range was already bounded (`>=4.0.0 <5`) and is now
+  written as the caret that means the same thing.
+
+  Peers nothing imports are gone. `rn-theme`, `rn-local-db` and `rn-notification` asked
+  for `react` without having a component or a hook between them; `rn-auth`, `rn-ai` and
+  `rn-i18n` asked for `react-native` without touching a React Native API (rn-auth reaches
+  both native modules through `lazyPeer`, rn-i18n formats on `Intl`); `rn-notification`
+  asked for `@react-native-firebase/app`, which messaging declares itself. `rn-ai` no
+  longer peers on `@chipmobilesdk/rn-auth` at all — it asks for a `TokenProvider`, a
+  two-method interface rn-auth's `auth` satisfies, so an app with its own token source
+  installs nothing extra. An app that enables push or signs in through rn-auth installs
+  the same packages as before; it is the manifest that stopped overstating.
+
+  `react-native-localize` is declared optional, which is what the code already did: the
+  time-zone reader goes through `lazyPeer` and falls back to `Intl` without it. The
+  `peerDependenciesMeta` entries that said `optional: false` are gone — that is npm's
+  default, and writing it down only invited the question of which peers were undecided.
+
+  `npm run check:manifests` now fails on an unbounded peer range, a peer nothing in
+  `src/` imports, and a `peerDependenciesMeta` entry for either, so the policy holds
+  without anyone remembering it.
+
+- Every package now ships built JavaScript with declaration files, instead of asking the
+  app to compile its TypeScript. ([#22](https://github.com/operationd8979/chip-mobile-sdk/pull/22))
+
+  Each tarball carries `lib/commonjs`, `lib/module` and `lib/typescript` (built with
+  `react-native-builder-bob`), and `src/` alongside them. What that changes for a
+  consumer:
+
+  - **Nothing to add to `transformIgnorePatterns`.** `require` resolves to the CommonJS
+    build, so an app's Jest loads this package without being told to transform it. That
+    was the one thing every consuming app had to know about us (DEP-04).
+  - **Typechecking reads our `.d.ts`** rather than compiling our source under our
+    `tsconfig`. A consumer's stricter — or looser — settings no longer meet our code.
+  - **`import` resolves to ESM**, so a bundler can tree-shake what it does not use.
+
+  No exported name changed, and no subpath moved: `.`, `./testing`, `./push`,
+  `./advanced`, `./app-auth`, `./keychain` and rn-core's twelve subpaths resolve exactly
+  as before, each now with its own declarations for both module systems. publint and
+  `attw --profile node16` pass on all twelve packages, which they could not before.
+
+  Inside the monorepo nothing changed either, and that is deliberate: every subpath also
+  declares a private `chipmobilesdk-source` condition pointing at its TypeScript, and
+  Metro, Jest and `tsc` here ask for that condition first. The demo app bundles 371
+  modules straight from `packages/*/src`, so editing a package still changes the app with
+  no build step, and coverage is still measured on the source. The condition is named for
+  this organization rather than using the conventional `source` because third-party
+  packages declare that one too — `@dr.pogodin/react-native-fs` does — and asking for it
+  pulled their sources into our stricter compile.
+
+  `npm run build:packages` builds everything, `prepack` rebuilds before any `npm pack`,
+  and `lib/` is git-ignored: the published bytes are produced by the release, never
+  committed. `npm run check:manifests` now fails a package whose `main`, `module`,
+  `types`, `source` condition, `files`, build script or `prepack` do not match this shape.
+
+### Patch Changes
+
+- The token source is documented as the interface it has always been. `createAiClient`
+  takes `auth: TokenProvider` — `requestAccessToken(resourceKey, { forceRefresh })` and
+  nothing else — which rn-auth's controller satisfies structurally, so passing `auth`
+  straight in keeps working. rn-auth stopped being a peer of this package in the same
+  release; an app with its own token source implements two methods' worth of interface
+  and installs nothing extra. The skill says so where it used to leave rn-auth implied,
+  and the demo app carries the assignment as a compile-time assertion, so a rename on
+  either side now fails `tsc` instead of surfacing at runtime. ([#21](https://github.com/operationd8979/chip-mobile-sdk/pull/21))
+
+- Each package's public API and its weight are now recorded in the repository, so a change
+  to either is reviewed rather than discovered. ([#23](https://github.com/operationd8979/chip-mobile-sdk/pull/23))
+
+  `packages/<pkg>/etc/*.api.md` is an api-extractor report per entrypoint — twenty-seven
+  of them, generated from the declarations the package publishes and committed. A renamed
+  type, a widened union, one more optional field: all of it shows up in a pull request's
+  diff. `npm run check:api` fails when a report is out of date and `npm run api:update`
+  rewrites them.
+
+  A report that moves now needs a **minor or major** changeset for that package.
+  `check:changesets` enforces it, because the report is generated from what the package
+  publishes, and a patch release that moves the public surface is how a consumer's build
+  breaks on `npm update`. A report added for the first time is a baseline, not a change.
+  `./testing` deliberately has no report: test doubles are not a surface a release is
+  gated on.
+
+  `npm run check:size` holds every entrypoint to a budget in `.size-limit.json`, measured
+  on the ESM build with peers and rn-core treated as external — they are what an app
+  installs beside us, not our weight. Each budget started at today's measurement plus five
+  per cent, so growth becomes a decision someone makes instead of a drift nobody sees. The
+  current figures run from 500 B (`rn-core/lazy`) to 19 kB (rn-notification).
+
+  No behaviour or API changed in this release; the entry is here so the changelog records
+  when the reports and the budgets began.
+- Updated dependencies ([#22](https://github.com/operationd8979/chip-mobile-sdk/pull/22), [#23](https://github.com/operationd8979/chip-mobile-sdk/pull/23)):
+  - @chipmobilesdk/rn-core@0.2.0
+
 ## 0.4.0
 
 ### Minor Changes

package/README.md

@@ -22,10 +22,13 @@ OpenAI directly and hold no AI credentials.
 ## Install
 
 ```bash
-npm install @chipmobilesdk/rn-ai @chipmobilesdk/rn-auth
+npm install @chipmobilesdk/rn-ai
 ```
 
-Peers: `react >=19`, `react-native >=0.85`, `@chipmobilesdk/rn-auth >=0.2.0`.
+The one peer is `react >=19`. `@chipmobilesdk/rn-auth` is no longer a peer: this
+package asks for a `TokenProvider`, a two-method interface rn-auth's `auth`
+happens to satisfy, so an app with its own token source installs nothing extra.
+Install rn-auth as well if you want it to be the token source.
 **Zero runtime dependencies**; streaming uses React Native's standard
 `XMLHttpRequest` (no native code, Hermes-compatible, iOS + Android).
 

package/lib/commonjs/config/behaviorConfig.js

@@ -0,0 +1,283 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SUPPORTED_SCHEMA_VERSION = exports.MemoryConfigCache = exports.BehaviorConfigManager = void 0;
+exports.configCacheFromKeyValue = configCacheFromKeyValue;
+exports.isTrustedUrl = isTrustedUrl;
+exports.parseBehaviorConfig = parseBehaviorConfig;
+var _rnCore = require("@chipmobilesdk/rn-core");
+var _errors = require("../diagnostics/errors.js");
+var _timeouts = require("../transport/timeouts.js");
+/** App behavior configuration (contracts/app-behavior-config.md). */
+
+/** Persistence port; default is in-memory (inject a durable store for offline launch). */
+
+class MemoryConfigCache {
+  map = new Map();
+  async get(key) {
+    return this.map.get(key) ?? null;
+  }
+  async set(key, value) {
+    this.map.set(key, value);
+  }
+}
+
+/**
+ * An `AiConfigCache` over rn-core's synchronous `KeyValuePort` (AI-10).
+ *
+ * Without a durable cache every launch waits for the network before the first
+ * chat, which is exactly what the cache-first design exists to avoid. Open the
+ * port the way the app opens its other durable state, for example
+ * `openDurable(() => createMMKV({ id: 'app' }))`.
+ */
+exports.MemoryConfigCache = MemoryConfigCache;
+function configCacheFromKeyValue(port) {
+  return {
+    async get(key) {
+      return port.getString(key) ?? null;
+    },
+    async set(key, value) {
+      port.set(key, value);
+    }
+  };
+}
+/** The newest document layout this release understands. */
+const SUPPORTED_SCHEMA_VERSION = exports.SUPPORTED_SCHEMA_VERSION = 1;
+
+/** Bounds on the remote-configured recovery, so a bad document cannot stall a chat. */
+const MAX_SILENT_RETRIES = 5;
+const MIN_REFRESH_TTL_SECONDS = 30;
+const DEFAULT_REFRESH_TTL_SECONDS = 21_600;
+const numbers = value => Array.isArray(value) ? value.filter(n => Number.isFinite(n)) : undefined;
+const positiveInt = (value, fallback) => typeof value === 'number' && Number.isFinite(value) && value > 0 ? Math.floor(value) : fallback;
+function invalid(reason) {
+  throw new _errors.AiError('config-unavailable', `behavior config ${reason}`);
+}
+
+/** https, or http on a development machine: a bearer token travels to this host. */
+function isTrustedUrl(url) {
+  if (/^https:\/\//i.test(url)) {
+    return true;
+  }
+  return /^http:\/\/(localhost|127\.0\.0\.1|\[::1\])(:\d+)?(\/|$)/i.test(url);
+}
+function hostOf(url) {
+  return url.replace(/^[a-z]+:\/\//i, '').split(/[/:?#]/)[0].toLowerCase();
+}
+/**
+ * Parse + validate; unknown fields ignored (forward compatibility).
+ *
+ * Every field this package acts on is checked here, because the document is
+ * remote and the alternative is a TypeError inside an XHR callback, a revalidate
+ * on every single request, or a bearer token sent to a host nobody vetted
+ * (AI-06, AI-07).
+ */
+function parseBehaviorConfig(json, options = {}) {
+  let raw;
+  try {
+    raw = JSON.parse(json);
+  } catch {
+    invalid('is not valid JSON');
+  }
+  const api = raw.api;
+  if (typeof raw.appId !== 'string' || typeof api?.baseUrl !== 'string' || !Array.isArray(api.scopes)) {
+    invalid('is missing required fields');
+  }
+  const schemaVersion = positiveInt(raw.schemaVersion, 1);
+  if (schemaVersion > SUPPORTED_SCHEMA_VERSION) {
+    // A newer layout may mean something different by the same field names.
+    invalid(`declares schema version ${schemaVersion}, newer than ${SUPPORTED_SCHEMA_VERSION}`);
+  }
+  if (options.expectedAppId !== undefined && raw.appId !== options.expectedAppId) {
+    // The cache key and the request path carry the app id; a document for
+    // another app would send this app's traffic somewhere else entirely.
+    invalid(`is for another app (${raw.appId})`);
+  }
+  const baseUrl = api.baseUrl.replace(/\/$/, '');
+  if (!isTrustedUrl(baseUrl)) {
+    invalid('names a baseUrl that is not https');
+  }
+  if (options.allowedHosts && !options.allowedHosts.includes(hostOf(baseUrl))) {
+    invalid(`names a baseUrl outside the allowed hosts (${hostOf(baseUrl)})`);
+  }
+  const recovery = raw.recovery ?? {};
+  const features = raw.features ?? {};
+  return {
+    schemaVersion,
+    appId: raw.appId,
+    configVersion: positiveInt(raw.configVersion, 0),
+    // A TTL that was NaN made `isFresh` false forever, so every request
+    // revalidated over the network (AI-06).
+    refreshTtlSeconds: Math.max(MIN_REFRESH_TTL_SECONDS, positiveInt(raw.refreshTtlSeconds, DEFAULT_REFRESH_TTL_SECONDS)),
+    api: {
+      baseUrl,
+      scopes: api.scopes.filter(s => typeof s === 'string'),
+      supportsStreaming: api.supportsStreaming !== false
+    },
+    limitsDisplay: raw.limitsDisplay,
+    // Typed here, once: a remote document with `reloadOnHttpStatus: "404"` used to
+    // throw a TypeError inside the XHR error callback, where nothing caught it.
+    recovery: {
+      reloadOnHttpStatus: numbers(recovery.reloadOnHttpStatus) ?? [404, 410],
+      maxSilentRetries: Math.min(MAX_SILENT_RETRIES, Number.isFinite(recovery.maxSilentRetries) ? Math.max(0, Number(recovery.maxSilentRetries)) : 1),
+      retryBackoffMs: numbers(recovery.retryBackoffMs) ?? [500, 2000]
+    },
+    features: {
+      aiEnabled: features.aiEnabled !== false
+    }
+  };
+}
+/**
+ * Cache-first behavior config (FR-018): launch never blocks on the network;
+ * TTL revalidation uses ETag; designated errors force a reload.
+ */
+class BehaviorConfigManager {
+  /**
+   * One cache read and one network fetch at a time (AI-08): a cold start makes a
+   * chat and a quota call together, and each used to fetch the config itself.
+   */
+  cacheRead = (0, _rnCore.createSingleFlight)();
+  networkFetch = (0, _rnCore.createSingleFlight)();
+  currentState = 'unloaded';
+  stateListeners = (0, _rnCore.createListenerSet)();
+
+  /** Where the config came from, or why there is none. */
+  get state() {
+    return this.currentState;
+  }
+
+  /** Called whenever `state` changes (AI-09). */
+  subscribe(listener) {
+    return this.stateListeners.add(listener);
+  }
+  setState(next) {
+    if (next === this.currentState) return;
+    this.currentState = next;
+    this.stateListeners.notify();
+  }
+  constructor(deps) {
+    this.deps = deps;
+    if (!isTrustedUrl(deps.configUrl)) {
+      // The document decides where the tokens go, so where it comes from
+      // matters as much (AI-07).
+      throw new _errors.AiError('config-unavailable', 'configUrl must be https');
+    }
+    this.cacheKey = `rn-ai:config:${deps.appId}`;
+    this.cache = deps.cache ?? new MemoryConfigCache();
+    this.fetchFn = deps.fetchFn ?? fetch;
+    this.now = deps.now ?? Date.now;
+  }
+  parse(json) {
+    return parseBehaviorConfig(json, {
+      expectedAppId: this.deps.appId,
+      ...(this.deps.allowedHosts ? {
+        allowedHosts: this.deps.allowedHosts
+      } : {})
+    });
+  }
+  isFresh(envelope, config) {
+    return this.now() - envelope.fetchedAt < config.refreshTtlSeconds * 1000;
+  }
+  loadFromCache() {
+    return this.current ? Promise.resolve() : this.cacheRead.run(() => this.readCache());
+  }
+  async readCache() {
+    if (this.current) return;
+    const stored = await this.cache.get(this.cacheKey).catch(() => null);
+    if (!stored) return;
+    try {
+      const envelope = JSON.parse(stored);
+      this.current = {
+        config: this.parse(envelope.configJson),
+        envelope
+      };
+      this.setState('ready-cache');
+    } catch {
+      // corrupted cache entries are ignored, not fatal
+    }
+  }
+  fetchNetwork() {
+    return this.networkFetch.run(() => this.fetchFromNetwork());
+  }
+
+  /** One attempt; `conditional` sends the stored ETag when there is one. */
+  async fetchOnce(conditional) {
+    const headers = {};
+    const etag = this.current?.envelope.etag;
+    if (conditional && etag) {
+      headers['If-None-Match'] = etag;
+    }
+    // Bounded: with no cache, a hung fetch used to block every chat and quota call.
+    return (0, _timeouts.withTimeout)(this.deps.timeoutMs ?? _timeouts.DEFAULT_AI_TIMEOUTS.configMs, async signal => {
+      const response = await this.fetchFn(this.deps.configUrl, {
+        headers,
+        signal
+      });
+      return {
+        status: response.status,
+        text: response.ok && response.status !== 304 ? await response.text() : '',
+        etag: response.headers.get('etag') ?? undefined
+      };
+    }, () => new _errors.AiError('config-unavailable', 'config fetch timed out'));
+  }
+  async fetchFromNetwork() {
+    let result = await this.fetchOnce(true);
+    if (result.status === 304) {
+      if (this.current) {
+        this.current.envelope.fetchedAt = this.now();
+        await this.persist(this.current.envelope);
+        this.setState('ready-network');
+        return this.current.config;
+      }
+      // Not-modified against a cache that is no longer there (it was cleared,
+      // or it failed to parse). Asking again without the ETag is the answer;
+      // reporting `config fetch failed: 304` was not (AI-17).
+      result = await this.fetchOnce(false);
+    }
+    if (result.status < 200 || result.status >= 300) {
+      throw new _errors.AiError('config-unavailable', `config fetch failed: ${result.status}`);
+    }
+    const config = this.parse(result.text);
+    const envelope = {
+      configJson: result.text,
+      etag: result.etag,
+      fetchedAt: this.now()
+    };
+    this.current = {
+      config,
+      envelope
+    };
+    await this.persist(envelope);
+    this.setState('ready-network');
+    return config;
+  }
+  async persist(envelope) {
+    await this.cache.set(this.cacheKey, JSON.stringify(envelope)).catch(() => undefined);
+  }
+
+  /**
+   * Cache-first read. Fresh cache returns immediately; stale cache returns
+   * immediately too while a background revalidation runs; no cache at all
+   * falls through to the network (or `config-unavailable`).
+   */
+  async getConfig(options = {}) {
+    await this.loadFromCache();
+    if (!options.forceReload && this.current) {
+      if (!this.isFresh(this.current.envelope, this.current.config)) {
+        this.fetchNetwork().catch(() => undefined); // background revalidate
+      }
+      return this.current.config;
+    }
+    try {
+      return await this.fetchNetwork();
+    } catch (e) {
+      if (this.current) return this.current.config; // stale beats broken
+      this.setState('unavailable');
+      throw e instanceof _errors.AiError ? e : new _errors.AiError('config-unavailable', String(e));
+    }
+  }
+}
+exports.BehaviorConfigManager = BehaviorConfigManager;
+//# sourceMappingURL=behaviorConfig.js.map

package/lib/commonjs/config/behaviorConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_rnCore","require","_errors","_timeouts","MemoryConfigCache","map","Map","get","key","set","value","exports","configCacheFromKeyValue","port","getString","SUPPORTED_SCHEMA_VERSION","MAX_SILENT_RETRIES","MIN_REFRESH_TTL_SECONDS","DEFAULT_REFRESH_TTL_SECONDS","numbers","Array","isArray","filter","n","Number","isFinite","undefined","positiveInt","fallback","Math","floor","invalid","reason","AiError","isTrustedUrl","url","test","hostOf","replace","split","toLowerCase","parseBehaviorConfig","json","options","raw","JSON","parse","api","appId","baseUrl","scopes","schemaVersion","expectedAppId","allowedHosts","includes","recovery","features","configVersion","refreshTtlSeconds","max","s","supportsStreaming","limitsDisplay","reloadOnHttpStatus","maxSilentRetries","min","retryBackoffMs","aiEnabled","BehaviorConfigManager","cacheRead","createSingleFlight","networkFetch","currentState","stateListeners","createListenerSet","state","subscribe","listener","add","setState","next","notify","constructor","deps","configUrl","cacheKey","cache","fetchFn","fetch","now","Date","isFresh","envelope","config","fetchedAt","loadFromCache","current","Promise","resolve","run","readCache","stored","catch","configJson","fetchNetwork","fetchFromNetwork","fetchOnce","conditional","headers","etag","withTimeout","timeoutMs","DEFAULT_AI_TIMEOUTS","configMs","signal","response","status","text","ok","result","persist","stringify","getConfig","forceReload","e","String"],"sourceRoot":"../../../src","sources":["config/behaviorConfig.ts"],"mappings":";;;;;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAEA,IAAAC,OAAA,GAAAD,OAAA;AACA,IAAAE,SAAA,GAAAF,OAAA;AAEA;;AAgBA;;AAMO,MAAMG,iBAAiB,CAA0B;EAC/CC,GAAG,GAAG,IAAIC,GAAG,CAAiB,CAAC;EACvC,MAAMC,GAAGA,CAACC,GAAW,EAA0B;IAC9C,OAAO,IAAI,CAACH,GAAG,CAACE,GAAG,CAACC,GAAG,CAAC,IAAI,IAAI;EACjC;EACA,MAAMC,GAAGA,CAACD,GAAW,EAAEE,KAAa,EAAiB;IACpD,IAAI,CAACL,GAAG,CAACI,GAAG,CAACD,GAAG,EAAEE,KAAK,CAAC;EACzB;AACD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAPAC,OAAA,CAAAP,iBAAA,GAAAA,iBAAA;AAQO,SAASQ,uBAAuBA,CAACC,IAAkB,EAAiB;EAC1E,OAAO;IACN,MAAMN,GAAGA,CAACC,GAAG,EAAE;MACd,OAAOK,IAAI,CAACC,SAAS,CAACN,GAAG,CAAC,IAAI,IAAI;IACnC,CAAC;IACD,MAAMC,GAAGA,CAACD,GAAG,EAAEE,KAAK,EAAE;MACrBG,IAAI,CAACJ,GAAG,CAACD,GAAG,EAAEE,KAAK,CAAC;IACrB;EACD,CAAC;AACF;AAIA;AACO,MAAMK,wBAAwB,GAAAJ,OAAA,CAAAI,wBAAA,GAAG,CAAC;;AAEzC;AACA,MAAMC,kBAAkB,GAAG,CAAC;AAC5B,MAAMC,uBAAuB,GAAG,EAAE;AAClC,MAAMC,2BAA2B,GAAG,MAAM;AAE1C,MAAMC,OAAO,GAAIT,KAAc,IAC9BU,KAAK,CAACC,OAAO,CAACX,KAAK,CAAC,GAAGA,KAAK,CAACY,MAAM,CAAEC,CAAC,IAAkBC,MAAM,CAACC,QAAQ,CAACF,CAAC,CAAC,CAAC,GAAGG,SAAS;AAExF,MAAMC,WAAW,GAAGA,CAACjB,KAAc,EAAEkB,QAAgB,KACpD,OAAOlB,KAAK,KAAK,QAAQ,IAAIc,MAAM,CAACC,QAAQ,CAACf,KAAK,CAAC,IAAIA,KAAK,GAAG,CAAC,GAAGmB,IAAI,CAACC,KAAK,CAACpB,KAAK,CAAC,GAAGkB,QAAQ;AAEhG,SAASG,OAAOA,CAACC,MAAc,EAAS;EACvC,MAAM,IAAIC,eAAO,CAAC,oBAAoB,EAAE,mBAAmBD,MAAM,EAAE,CAAC;AACrE;;AAEA;AACO,SAASE,YAAYA,CAACC,GAAW,EAAW;EAClD,IAAI,cAAc,CAACC,IAAI,CAACD,GAAG,CAAC,EAAE;IAC7B,OAAO,IAAI;EACZ;EACA,OAAO,0DAA0D,CAACC,IAAI,CAACD,GAAG,CAAC;AAC5E;AAEA,SAASE,MAAMA,CAACF,GAAW,EAAU;EACpC,OAAOA,GAAG,CACRG,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAC5BC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAClBC,WAAW,CAAC,CAAC;AAChB;AASA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,mBAAmBA,CAClCC,IAAY,EACZC,OAAmC,GAAG,CAAC,CAAC,EACpB;EACpB,IAAIC,GAA4B;EAChC,IAAI;IACHA,GAAG,GAAGC,IAAI,CAACC,KAAK,CAACJ,IAAI,CAA4B;EAClD,CAAC,CAAC,MAAM;IACPX,OAAO,CAAC,mBAAmB,CAAC;EAC7B;EACA,MAAMgB,GAAG,GAAGH,GAAG,CAACG,GAAoD;EACpE,IACC,OAAOH,GAAG,CAACI,KAAK,KAAK,QAAQ,IAC7B,OAAOD,GAAG,EAAEE,OAAO,KAAK,QAAQ,IAChC,CAAC7B,KAAK,CAACC,OAAO,CAAC0B,GAAG,CAACG,MAAM,CAAC,EACzB;IACDnB,OAAO,CAAC,4BAA4B,CAAC;EACtC;EAEA,MAAMoB,aAAa,GAAGxB,WAAW,CAACiB,GAAG,CAACO,aAAa,EAAE,CAAC,CAAC;EACvD,IAAIA,aAAa,GAAGpC,wBAAwB,EAAE;IAC7C;IACAgB,OAAO,CAAC,2BAA2BoB,aAAa,gBAAgBpC,wBAAwB,EAAE,CAAC;EAC5F;EACA,IAAI4B,OAAO,CAACS,aAAa,KAAK1B,SAAS,IAAIkB,GAAG,CAACI,KAAK,KAAKL,OAAO,CAACS,aAAa,EAAE;IAC/E;IACA;IACArB,OAAO,CAAC,uBAAuBa,GAAG,CAACI,KAAK,GAAG,CAAC;EAC7C;EAEA,MAAMC,OAAO,GAAGF,GAAG,CAACE,OAAO,CAACX,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;EAC9C,IAAI,CAACJ,YAAY,CAACe,OAAO,CAAC,EAAE;IAC3BlB,OAAO,CAAC,mCAAmC,CAAC;EAC7C;EACA,IAAIY,OAAO,CAACU,YAAY,IAAI,CAACV,OAAO,CAACU,YAAY,CAACC,QAAQ,CAACjB,MAAM,CAACY,OAAO,CAAC,CAAC,EAAE;IAC5ElB,OAAO,CAAC,8CAA8CM,MAAM,CAACY,OAAO,CAAC,GAAG,CAAC;EAC1E;EAEA,MAAMM,QAAQ,GAAIX,GAAG,CAACW,QAAQ,IAAI,CAAC,CAA4C;EAC/E,MAAMC,QAAQ,GAAIZ,GAAG,CAACY,QAAQ,IAAI,CAAC,CAA4C;EAC/E,OAAO;IACNL,aAAa;IACbH,KAAK,EAAEJ,GAAG,CAACI,KAAK;IAChBS,aAAa,EAAE9B,WAAW,CAACiB,GAAG,CAACa,aAAa,EAAE,CAAC,CAAC;IAChD;IACA;IACAC,iBAAiB,EAAE7B,IAAI,CAAC8B,GAAG,CAC1B1C,uBAAuB,EACvBU,WAAW,CAACiB,GAAG,CAACc,iBAAiB,EAAExC,2BAA2B,CAC/D,CAAC;IACD6B,GAAG,EAAE;MACJE,OAAO;MACPC,MAAM,EAAEH,GAAG,CAACG,MAAM,CAAC5B,MAAM,CAAEsC,CAAC,IAAkB,OAAOA,CAAC,KAAK,QAAQ,CAAC;MACpEC,iBAAiB,EAAEd,GAAG,CAACc,iBAAiB,KAAK;IAC9C,CAAC;IACDC,aAAa,EAAElB,GAAG,CAACkB,aAAmD;IACtE;IACA;IACAP,QAAQ,EAAE;MACTQ,kBAAkB,EAAE5C,OAAO,CAACoC,QAAQ,CAACQ,kBAAkB,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC;MACtEC,gBAAgB,EAAEnC,IAAI,CAACoC,GAAG,CACzBjD,kBAAkB,EAClBQ,MAAM,CAACC,QAAQ,CAAC8B,QAAQ,CAACS,gBAAgB,CAAC,GACvCnC,IAAI,CAAC8B,GAAG,CAAC,CAAC,EAAEnC,MAAM,CAAC+B,QAAQ,CAACS,gBAAgB,CAAC,CAAC,GAC9C,CACJ,CAAC;MACDE,cAAc,EAAE/C,OAAO,CAACoC,QAAQ,CAACW,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI;IAC/D,CAAC;IACDV,QAAQ,EAAE;MAAEW,SAAS,EAAEX,QAAQ,CAACW,SAAS,KAAK;IAAM;EACrD,CAAC;AACF;AAoBA;AACA;AACA;AACA;AACO,MAAMC,qBAAqB,CAAC;EAMlC;AACD;AACA;AACA;EACkBC,SAAS,GAAG,IAAAC,0BAAkB,EAAO,CAAC;EACtCC,YAAY,GAAG,IAAAD,0BAAkB,EAAoB,CAAC;EAC/DE,YAAY,GAAkB,UAAU;EAC/BC,cAAc,GAAG,IAAAC,yBAAiB,EAAK,CAAC;;EAEzD;EACA,IAAIC,KAAKA,CAAA,EAAkB;IAC1B,OAAO,IAAI,CAACH,YAAY;EACzB;;EAEA;EACAI,SAASA,CAACC,QAAoB,EAAc;IAC3C,OAAO,IAAI,CAACJ,cAAc,CAACK,GAAG,CAACD,QAAQ,CAAC;EACzC;EAEQE,QAAQA,CAACC,IAAmB,EAAQ;IAC3C,IAAIA,IAAI,KAAK,IAAI,CAACR,YAAY,EAAE;IAChC,IAAI,CAACA,YAAY,GAAGQ,IAAI;IACxB,IAAI,CAACP,cAAc,CAACQ,MAAM,CAAC,CAAC;EAC7B;EAEAC,WAAWA,CAASC,IAAwB,EAAE;IAAA,KAA1BA,IAAwB,GAAxBA,IAAwB;IAC3C,IAAI,CAACjD,YAAY,CAACiD,IAAI,CAACC,SAAS,CAAC,EAAE;MAClC;MACA;MACA,MAAM,IAAInD,eAAO,CAAC,oBAAoB,EAAE,yBAAyB,CAAC;IACnE;IACA,IAAI,CAACoD,QAAQ,GAAG,gBAAgBF,IAAI,CAACnC,KAAK,EAAE;IAC5C,IAAI,CAACsC,KAAK,GAAGH,IAAI,CAACG,KAAK,IAAI,IAAIlF,iBAAiB,CAAC,CAAC;IAClD,IAAI,CAACmF,OAAO,GAAGJ,IAAI,CAACI,OAAO,IAAIC,KAAK;IACpC,IAAI,CAACC,GAAG,GAAGN,IAAI,CAACM,GAAG,IAAIC,IAAI,CAACD,GAAG;EAChC;EAEQ3C,KAAKA,CAACJ,IAAY,EAAqB;IAC9C,OAAOD,mBAAmB,CAACC,IAAI,EAAE;MAChCU,aAAa,EAAE,IAAI,CAAC+B,IAAI,CAACnC,KAAK;MAC9B,IAAI,IAAI,CAACmC,IAAI,CAAC9B,YAAY,GAAG;QAAEA,YAAY,EAAE,IAAI,CAAC8B,IAAI,CAAC9B;MAAa,CAAC,GAAG,CAAC,CAAC;IAC3E,CAAC,CAAC;EACH;EAEQsC,OAAOA,CAACC,QAAuB,EAAEC,MAAyB,EAAW;IAC5E,OAAO,IAAI,CAACJ,GAAG,CAAC,CAAC,GAAGG,QAAQ,CAACE,SAAS,GAAGD,MAAM,CAACnC,iBAAiB,GAAG,IAAI;EACzE;EAEQqC,aAAaA,CAAA,EAAkB;IACtC,OAAO,IAAI,CAACC,OAAO,GAAGC,OAAO,CAACC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC7B,SAAS,CAAC8B,GAAG,CAAC,MAAM,IAAI,CAACC,SAAS,CAAC,CAAC,CAAC;EACrF;EAEA,MAAcA,SAASA,CAAA,EAAkB;IACxC,IAAI,IAAI,CAACJ,OAAO,EAAE;IAClB,MAAMK,MAAM,GAAG,MAAM,IAAI,CAACf,KAAK,CAAC/E,GAAG,CAAC,IAAI,CAAC8E,QAAQ,CAAC,CAACiB,KAAK,CAAC,MAAM,IAAI,CAAC;IACpE,IAAI,CAACD,MAAM,EAAE;IACb,IAAI;MACH,MAAMT,QAAQ,GAAG/C,IAAI,CAACC,KAAK,CAACuD,MAAM,CAAkB;MACpD,IAAI,CAACL,OAAO,GAAG;QAAEH,MAAM,EAAE,IAAI,CAAC/C,KAAK,CAAC8C,QAAQ,CAACW,UAAU,CAAC;QAAEX;MAAS,CAAC;MACpE,IAAI,CAACb,QAAQ,CAAC,aAAa,CAAC;IAC7B,CAAC,CAAC,MAAM;MACP;IAAA;EAEF;EAEQyB,YAAYA,CAAA,EAA+B;IAClD,OAAO,IAAI,CAACjC,YAAY,CAAC4B,GAAG,CAAC,MAAM,IAAI,CAACM,gBAAgB,CAAC,CAAC,CAAC;EAC5D;;EAEA;EACA,MAAcC,SAASA,CACtBC,WAAoB,EACuC;IAC3D,MAAMC,OAA+B,GAAG,CAAC,CAAC;IAC1C,MAAMC,IAAI,GAAG,IAAI,CAACb,OAAO,EAAEJ,QAAQ,CAACiB,IAAI;IACxC,IAAIF,WAAW,IAAIE,IAAI,EAAE;MACxBD,OAAO,CAAC,eAAe,CAAC,GAAGC,IAAI;IAChC;IACA;IACA,OAAO,IAAAC,qBAAW,EACjB,IAAI,CAAC3B,IAAI,CAAC4B,SAAS,IAAIC,6BAAmB,CAACC,QAAQ,EACnD,MAAMC,MAAM,IAAI;MACf,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAAC5B,OAAO,CAAC,IAAI,CAACJ,IAAI,CAACC,SAAS,EAAE;QAAEwB,OAAO;QAAEM;MAAO,CAAC,CAAC;MAC7E,OAAO;QACNE,MAAM,EAAED,QAAQ,CAACC,MAAM;QACvBC,IAAI,EAAEF,QAAQ,CAACG,EAAE,IAAIH,QAAQ,CAACC,MAAM,KAAK,GAAG,GAAG,MAAMD,QAAQ,CAACE,IAAI,CAAC,CAAC,GAAG,EAAE;QACzER,IAAI,EAAEM,QAAQ,CAACP,OAAO,CAACrG,GAAG,CAAC,MAAM,CAAC,IAAImB;MACvC,CAAC;IACF,CAAC,EACD,MAAM,IAAIO,eAAO,CAAC,oBAAoB,EAAE,wBAAwB,CACjE,CAAC;EACF;EAEA,MAAcwE,gBAAgBA,CAAA,EAA+B;IAC5D,IAAIc,MAAM,GAAG,MAAM,IAAI,CAACb,SAAS,CAAC,IAAI,CAAC;IACvC,IAAIa,MAAM,CAACH,MAAM,KAAK,GAAG,EAAE;MAC1B,IAAI,IAAI,CAACpB,OAAO,EAAE;QACjB,IAAI,CAACA,OAAO,CAACJ,QAAQ,CAACE,SAAS,GAAG,IAAI,CAACL,GAAG,CAAC,CAAC;QAC5C,MAAM,IAAI,CAAC+B,OAAO,CAAC,IAAI,CAACxB,OAAO,CAACJ,QAAQ,CAAC;QACzC,IAAI,CAACb,QAAQ,CAAC,eAAe,CAAC;QAC9B,OAAO,IAAI,CAACiB,OAAO,CAACH,MAAM;MAC3B;MACA;MACA;MACA;MACA0B,MAAM,GAAG,MAAM,IAAI,CAACb,SAAS,CAAC,KAAK,CAAC;IACrC;IACA,IAAIa,MAAM,CAACH,MAAM,GAAG,GAAG,IAAIG,MAAM,CAACH,MAAM,IAAI,GAAG,EAAE;MAChD,MAAM,IAAInF,eAAO,CAAC,oBAAoB,EAAE,wBAAwBsF,MAAM,CAACH,MAAM,EAAE,CAAC;IACjF;IACA,MAAMvB,MAAM,GAAG,IAAI,CAAC/C,KAAK,CAACyE,MAAM,CAACF,IAAI,CAAC;IACtC,MAAMzB,QAAuB,GAAG;MAC/BW,UAAU,EAAEgB,MAAM,CAACF,IAAI;MACvBR,IAAI,EAAEU,MAAM,CAACV,IAAI;MACjBf,SAAS,EAAE,IAAI,CAACL,GAAG,CAAC;IACrB,CAAC;IACD,IAAI,CAACO,OAAO,GAAG;MAAEH,MAAM;MAAED;IAAS,CAAC;IACnC,MAAM,IAAI,CAAC4B,OAAO,CAAC5B,QAAQ,CAAC;IAC5B,IAAI,CAACb,QAAQ,CAAC,eAAe,CAAC;IAC9B,OAAOc,MAAM;EACd;EAEA,MAAc2B,OAAOA,CAAC5B,QAAuB,EAAiB;IAC7D,MAAM,IAAI,CAACN,KAAK,CAAC7E,GAAG,CAAC,IAAI,CAAC4E,QAAQ,EAAExC,IAAI,CAAC4E,SAAS,CAAC7B,QAAQ,CAAC,CAAC,CAACU,KAAK,CAAC,MAAM5E,SAAS,CAAC;EACrF;;EAEA;AACD;AACA;AACA;AACA;EACC,MAAMgG,SAASA,CAAC/E,OAAkC,GAAG,CAAC,CAAC,EAA8B;IACpF,MAAM,IAAI,CAACoD,aAAa,CAAC,CAAC;IAC1B,IAAI,CAACpD,OAAO,CAACgF,WAAW,IAAI,IAAI,CAAC3B,OAAO,EAAE;MACzC,IAAI,CAAC,IAAI,CAACL,OAAO,CAAC,IAAI,CAACK,OAAO,CAACJ,QAAQ,EAAE,IAAI,CAACI,OAAO,CAACH,MAAM,CAAC,EAAE;QAC9D,IAAI,CAACW,YAAY,CAAC,CAAC,CAACF,KAAK,CAAC,MAAM5E,SAAS,CAAC,CAAC,CAAC;MAC7C;MACA,OAAO,IAAI,CAACsE,OAAO,CAACH,MAAM;IAC3B;IACA,IAAI;MACH,OAAO,MAAM,IAAI,CAACW,YAAY,CAAC,CAAC;IACjC,CAAC,CAAC,OAAOoB,CAAC,EAAE;MACX,IAAI,IAAI,CAAC5B,OAAO,EAAE,OAAO,IAAI,CAACA,OAAO,CAACH,MAAM,CAAC,CAAC;MAC9C,IAAI,CAACd,QAAQ,CAAC,aAAa,CAAC;MAC5B,MAAM6C,CAAC,YAAY3F,eAAO,GAAG2F,CAAC,GAAG,IAAI3F,eAAO,CAAC,oBAAoB,EAAE4F,MAAM,CAACD,CAAC,CAAC,CAAC;IAC9E;EACD;AACD;AAACjH,OAAA,CAAAyD,qBAAA,GAAAA,qBAAA","ignoreList":[]}

package/lib/commonjs/contract/gateway.js

@@ -0,0 +1,60 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SSE_DONE_SENTINEL = exports.RETRY_AFTER_HEADER = exports.QUOTA_HEADERS = exports.GATEWAY_ERROR_STATUS = void 0;
+/**
+ * The gateway↔client contract: error codes, quota headers, stream events.
+ *
+ * One definition, imported by both sides (GW-13). The gateway's own codes and
+ * the client's map of them were two hand-maintained lists, and they had already
+ * drifted: `BAD_REQUEST`, `ENDPOINT_RETIRED` and `INTERNAL` existed on the
+ * server and were unknown to the client, which fell back to a guess from the
+ * status. Adding a code now fails to compile on whichever side has not handled
+ * it.
+ *
+ * Types and plain constants only, and no import of anything: the gateway runs
+ * on Node and imports this file for its types alone.
+ */
+
+/** Every error the gateway answers with (`error.code` in the body). */
+
+/** The HTTP status each code is sent with. */
+const GATEWAY_ERROR_STATUS = exports.GATEWAY_ERROR_STATUS = {
+  BAD_REQUEST: 400,
+  AUTH_INVALID: 401,
+  NOT_ENTITLED: 403,
+  USER_BLOCKED: 403,
+  APP_UNKNOWN: 404,
+  ENDPOINT_RETIRED: 410,
+  PAYLOAD_TOO_LARGE: 413,
+  MODALITY_NOT_ALLOWED: 415,
+  RATE_LIMITED: 429,
+  UPSTREAM_BUSY: 429,
+  UPSTREAM_ERROR: 500,
+  INTERNAL: 500
+};
+
+/** The error body. `message` is safe to log; it never carries upstream detail. */
+
+/** The quota headers, by name. A rename here breaks both sides' compile. */
+const QUOTA_HEADERS = exports.QUOTA_HEADERS = {
+  minuteRemaining: 'X-Quota-Minute-Remaining',
+  dayRemaining: 'X-Quota-Day-Remaining',
+  dayTokensRemaining: 'X-Quota-Day-Tokens-Remaining'
+};
+
+/** The names field by field, so a side declaring its own literals is checked exactly. */
+
+/** What is left of an app's allowance, as the gateway reports it. */
+
+/** What one answer cost. */
+
+/** The `data:` payloads of a chat stream, before the `[DONE]` sentinel. */
+
+/** The last `data:` line of a stream that completed. */
+const SSE_DONE_SENTINEL = exports.SSE_DONE_SENTINEL = '[DONE]';
+/** The `Retry-After` header, which a 429 always carries. */
+const RETRY_AFTER_HEADER = exports.RETRY_AFTER_HEADER = 'Retry-After';
+//# sourceMappingURL=gateway.js.map

package/lib/commonjs/contract/gateway.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["GATEWAY_ERROR_STATUS","exports","BAD_REQUEST","AUTH_INVALID","NOT_ENTITLED","USER_BLOCKED","APP_UNKNOWN","ENDPOINT_RETIRED","PAYLOAD_TOO_LARGE","MODALITY_NOT_ALLOWED","RATE_LIMITED","UPSTREAM_BUSY","UPSTREAM_ERROR","INTERNAL","QUOTA_HEADERS","minuteRemaining","dayRemaining","dayTokensRemaining","SSE_DONE_SENTINEL","RETRY_AFTER_HEADER"],"sourceRoot":"../../../src","sources":["contract/gateway.ts"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;;AAeA;AACO,MAAMA,oBAAgE,GAAAC,OAAA,CAAAD,oBAAA,GAAG;EAC/EE,WAAW,EAAE,GAAG;EAChBC,YAAY,EAAE,GAAG;EACjBC,YAAY,EAAE,GAAG;EACjBC,YAAY,EAAE,GAAG;EACjBC,WAAW,EAAE,GAAG;EAChBC,gBAAgB,EAAE,GAAG;EACrBC,iBAAiB,EAAE,GAAG;EACtBC,oBAAoB,EAAE,GAAG;EACzBC,YAAY,EAAE,GAAG;EACjBC,aAAa,EAAE,GAAG;EAClBC,cAAc,EAAE,GAAG;EACnBC,QAAQ,EAAE;AACX,CAAC;;AAED;;AASA;AACO,MAAMC,aAAa,GAAAb,OAAA,CAAAa,aAAA,GAAG;EAC5BC,eAAe,EAAE,0BAA0B;EAC3CC,YAAY,EAAE,uBAAuB;EACrCC,kBAAkB,EAAE;AACrB,CAAU;;AAEV;;AAIA;;AAOA;;AAOA;;AAMA;AACO,MAAMC,iBAAiB,GAAAjB,OAAA,CAAAiB,iBAAA,GAAG,QAAQ;AAGzC;AACO,MAAMC,kBAAkB,GAAAlB,OAAA,CAAAkB,kBAAA,GAAG,aAAa","ignoreList":[]}