@faable/deploy-sdk 2.17.1 → 2.18.1

package/dist/informers/deployApiWatchClient.js

@@ -0,0 +1,36 @@
+import { ndjson } from "./ndjson.js";
+import { WatchExpiredError, } from "./WatchClient.js";
+// The WatchClient over the deploy API's fetcher (auth, identity headers and
+// baseURL included): GET /watch/list and the NDJSON stream of GET /watch.
+//
+// ⚠️ The client must not have `etagCache` on: the ETag path would treat the
+// stream as a cacheable body. Build a separate DeployApi for informers.
+const isGone = (err) => err?.response?.status === 410 || err?.status === 410 || err?.statusCode === 410;
+export const deployApiWatchClient = (fetcher) => ({
+    list: async (resource) => fetcher.request({
+        method: "GET",
+        url: "/watch/list",
+        params: { resource },
+    }),
+    watch: (resources, rv, signal) => ({
+        async *[Symbol.asyncIterator]() {
+            let stream;
+            try {
+                stream = await fetcher.request({
+                    method: "GET",
+                    url: "/watch",
+                    params: { resources: resources.join(","), rv },
+                    responseType: "stream",
+                    timeout: 0,
+                    signal,
+                });
+            }
+            catch (err) {
+                if (isGone(err))
+                    throw new WatchExpiredError();
+                throw err;
+            }
+            yield* ndjson(stream);
+        },
+    }),
+});

package/dist/informers/index.d.ts

@@ -0,0 +1,6 @@
+export { Indexer, type IndexFn } from "./Indexer.js";
+export { InformerFactory, SharedInformer, WatchIdleError, type InformerEvent, type InformerFactoryOptions, } from "./InformerFactory.js";
+export { compareRv, minRv, rvGeneration, rvTimeMs } from "./rv.js";
+export { WatchExpiredError, type ListResult, type WatchClient, type WatchEvent, type WatchResource, } from "./WatchClient.js";
+export { deployApiWatchClient } from "./deployApiWatchClient.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/informers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/informers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,cAAc,CAAA;AACpD,OAAO,EACL,eAAe,EACf,cAAc,EACd,cAAc,EACd,KAAK,aAAa,EAClB,KAAK,sBAAsB,GAC5B,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAClE,OAAO,EACL,iBAAiB,EACjB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,aAAa,GACnB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA"}

package/dist/informers/index.js

@@ -0,0 +1,5 @@
+export { Indexer } from "./Indexer.js";
+export { InformerFactory, SharedInformer, WatchIdleError, } from "./InformerFactory.js";
+export { compareRv, minRv, rvGeneration, rvTimeMs } from "./rv.js";
+export { WatchExpiredError, } from "./WatchClient.js";
+export { deployApiWatchClient } from "./deployApiWatchClient.js";

package/dist/informers/ndjson.d.ts

@@ -0,0 +1,2 @@
+export declare function ndjson(chunks: AsyncIterable<Uint8Array | string>): AsyncGenerator<any>;
+//# sourceMappingURL=ndjson.d.ts.map

package/dist/informers/ndjson.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ndjson.d.ts","sourceRoot":"","sources":["../../src/informers/ndjson.ts"],"names":[],"mappings":"AAEA,wBAAuB,MAAM,CAC3B,MAAM,EAAE,aAAa,CAAC,UAAU,GAAG,MAAM,CAAC,GACzC,cAAc,CAAC,GAAG,CAAC,CAcrB"}

package/dist/informers/ndjson.js

@@ -0,0 +1,19 @@
+// Lines of an NDJSON byte stream (Node Readable or any async iterable of
+// chunks), parsed. A partial last line is kept until it completes.
+export async function* ndjson(chunks) {
+    const decoder = new TextDecoder();
+    let buf = "";
+    for await (const chunk of chunks) {
+        buf += typeof chunk === "string" ? chunk : decoder.decode(chunk, { stream: true });
+        let i;
+        while ((i = buf.indexOf("\n")) >= 0) {
+            const line = buf.slice(0, i).trim();
+            buf = buf.slice(i + 1);
+            if (line)
+                yield JSON.parse(line);
+        }
+    }
+    const last = buf.trim();
+    if (last)
+        yield JSON.parse(last);
+}

package/dist/informers/rv.d.ts

@@ -0,0 +1,15 @@
+/** <0, 0, >0 like a comparator; an unparsable rv sorts first. */
+export declare const compareRv: (a: string, b: string) => number;
+/**
+ * When the change entered the cache's stream (ms since epoch), from the
+ * stream position in an rv. `now - rvTimeMs(rv)` is how long the event took
+ * to reach this process — the informer's freshness. null if unparsable.
+ */
+export declare const rvTimeMs: (rv: string) => number | null;
+/**
+ * The generation of an rv (it changes when the server's stream is reset).
+ * rvs of different generations are not comparable. null if unparsable.
+ */
+export declare const rvGeneration: (rv: string) => number | null;
+export declare const minRv: (rvs: string[]) => string;
+//# sourceMappingURL=rv.d.ts.map

package/dist/informers/rv.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rv.d.ts","sourceRoot":"","sources":["../../src/informers/rv.ts"],"names":[],"mappings":"AASA,iEAAiE;AACjE,eAAO,MAAM,SAAS,MAAO,MAAM,KAAK,MAAM,KAAG,MAKhD,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,QAAQ,OAAQ,MAAM,KAAG,MAAM,GAAG,IAG9C,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,YAAY,OAAQ,MAAM,KAAG,MAAM,GAAG,IAGlD,CAAA;AAED,eAAO,MAAM,KAAK,QAAS,MAAM,EAAE,KAAG,MACe,CAAA"}

package/dist/informers/rv.js

@@ -0,0 +1,33 @@
+// A resourceVersion from the watch API: `<generation>.<streamMs>-<seq>`
+// (arch/api/informers.md § 1). Ordered by generation, then stream position.
+// Opaque to callers; only compared here.
+const parse = (rv) => {
+    const m = /^(\d+)\.(\d+)-(\d+)$/.exec(rv);
+    return m ? [Number(m[1]), Number(m[2]), Number(m[3])] : null;
+};
+/** <0, 0, >0 like a comparator; an unparsable rv sorts first. */
+export const compareRv = (a, b) => {
+    const pa = parse(a);
+    const pb = parse(b);
+    if (!pa || !pb)
+        return pa ? 1 : pb ? -1 : 0;
+    return pa[0] - pb[0] || pa[1] - pb[1] || pa[2] - pb[2];
+};
+/**
+ * When the change entered the cache's stream (ms since epoch), from the
+ * stream position in an rv. `now - rvTimeMs(rv)` is how long the event took
+ * to reach this process — the informer's freshness. null if unparsable.
+ */
+export const rvTimeMs = (rv) => {
+    const p = parse(rv);
+    return p ? p[1] : null;
+};
+/**
+ * The generation of an rv (it changes when the server's stream is reset).
+ * rvs of different generations are not comparable. null if unparsable.
+ */
+export const rvGeneration = (rv) => {
+    const p = parse(rv);
+    return p ? p[0] : null;
+};
+export const minRv = (rvs) => rvs.reduce((m, r) => (compareRv(r, m) < 0 ? r : m));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@faable/deploy-sdk",
   "description": "Codebase for SDK building",
-  "version": "2.17.1",
+  "version": "2.18.1",
   "author": "Marc Pomar <marc@faable.com>",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",