@conduit-client/command-sse 5.67.0-dev1

package/LICENSE.txt

@@ -0,0 +1,27 @@
+*Attorney/Client Privileged + Confidential*
+
+Terms of Use for Public Code (Non-OSS)
+
+*NOTE:* Before publishing code under this license/these Terms of Use, please review https://salesforce.quip.com/WFfvAMKB18AL and confirm that you’ve completed all prerequisites described therein. *These Terms of Use may not be used or modified without input from IP and Product Legal.*
+
+*Terms of Use*
+
+Copyright 2022 Salesforce, Inc. All rights reserved. 
+
+These Terms of Use govern the download, installation, and/or use of this software provided by Salesforce, Inc. (“Salesforce”) (the “Software”), were last updated on April 15, 2022, ** and constitute a legally binding agreement between you and Salesforce. If you do not agree to these Terms of Use, do not install or use the Software. 
+ 
+Salesforce grants you a worldwide, non-exclusive, no-charge, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute the Software and derivative works subject to these Terms. These Terms shall be included in all copies or substantial portions of the Software. 
+
+Subject to the limited rights expressly granted hereunder, Salesforce reserves all rights, title, and interest in and to all intellectual property subsisting in the Software. No rights are granted to you hereunder other than as expressly set forth herein. Users residing in countries on the United States Office of Foreign Assets Control sanction list, or which are otherwise subject to a US export embargo, may not use the Software.
+ 
+Implementation of the Software may require development work, for which you are responsible. The Software may contain bugs, errors and incompatibilities and is made available on an AS IS basis without support, updates, or service level commitments. 
+ 
+Salesforce reserves the right at any time to modify, suspend, or discontinue, the Software (or any part thereof) with or without notice. You agree that Salesforce shall not be liable to you or to any third party for any modification, suspension, or discontinuance.
+
+You agree to defend Salesforce against any claim, demand, suit or proceeding made or brought against Salesforce by a third party arising out of or accruing from (a) your use of the Software, and (b) any application you develop with the Software that infringes any copyright, trademark, trade secret, trade dress, patent, or other intellectual property right of any person or defames any person or violates their rights of publicity or privacy (each a “Claim Against Salesforce”), and will indemnify Salesforce from any damages, attorney fees, and costs finally awarded against Salesforce as a result of, or for any amounts paid by Salesforce under a settlement approved by you in writing of, a Claim Against Salesforce, provided Salesforce (x) promptly gives you written notice of the Claim Against Salesforce, (y) gives you sole control of the defense and settlement of the Claim Against Salesforce (except that you may not settle any Claim Against Salesforce unless it unconditionally releases Salesforce of all liability), and (z) gives you all reasonable assistance, at your expense.
+
+WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE SOFTWARE IS NOT SUPPORTED AND IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. IN NO EVENT SHALL SALESFORCE HAVE ANY LIABILITY FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES, OR DAMAGES BASED ON LOST PROFITS, DATA, OR USE, IN CONNECTION WITH THE SOFTWARE, HOWEVER CAUSED AND WHETHER IN CONTRACT, TORT, OR UNDER ANY OTHER THEORY OF LIABILITY, WHETHER OR NOT YOU HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+ 
+These Terms of Use shall be governed exclusively by the internal laws of the State of California, without regard to its conflicts of laws rules. Each party hereby consents to the exclusive jurisdiction of the state and federal courts located in San Francisco County, California to adjudicate any dispute arising out of or relating to these Terms of Use and the download, installation, and/or use of the Software. Except as expressly stated herein, these Terms of Use constitute the entire agreement between the parties, and supersede all prior and contemporaneous agreements, proposals, or representations, written or oral, concerning their subject matter. No modification, amendment, or waiver of any provision of these Terms of Use shall be effective unless it is by an update to these Terms of Use that Salesforce makes available, or is in writing and signed by the party against whom the modification, amendment, or waiver is to be asserted.
+
+_*Data Privacy*_: Salesforce may collect, process, and store device, system, and other information related to your use of the Software. This information includes, but is not limited to, IP address, user metrics, and other data (“Usage Data”). Salesforce may use Usage Data for analytics, product development, and marketing purposes. You acknowledge that files generated in conjunction with the Software may contain sensitive or confidential data, and you are solely responsible for anonymizing and protecting such data.  

package/README.md

@@ -0,0 +1 @@
+This software is provided as-is with no support provided.

package/dist/main/index.js

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) 2022, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+//# sourceMappingURL=index.js.map

package/dist/main/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}

package/dist/types/v1/__tests__/index.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/v1/__tests__/sse-command.spec.d.ts

@@ -0,0 +1 @@
+export declare function generateNetworkResponse(result: any): Promise<any>;

package/dist/types/v1/index.d.ts

@@ -0,0 +1,6 @@
+import { type ServiceDescriptor } from '@conduit-client/utils';
+import { SSECommand } from './sse-command';
+export { type SSEMessage } from './sse-command';
+export { SSECommand } from './sse-command';
+export type SSECommandServiceDescriptor = ServiceDescriptor<typeof SSECommand, 'SSECommandBaseClass', '1.0'>;
+export declare function buildServiceDescriptor(): SSECommandServiceDescriptor;

package/dist/types/v1/sse-command.d.ts

@@ -0,0 +1,30 @@
+import { StreamingCommand } from '@conduit-client/command-streaming/v1';
+import type { NamedFetchService } from '@conduit-client/service-fetch-network/v1';
+export type SSEMessage = {
+    event: string;
+    data: string;
+    id: string;
+    retry?: number;
+};
+/**
+ * An implementation of StreamingCommand that handles SSE (Server-Sent Event) streams.
+ */
+export declare abstract class SSECommand<StreamedData = SSEMessage, ExtraServices extends object = object> extends StreamingCommand<StreamedData, ExtraServices> {
+    protected services: NamedFetchService & ExtraServices;
+    constructor(services: NamedFetchService & ExtraServices);
+    /**
+     * Decodes the bytes returned by fetch into the correct shape.
+     *
+     * @param byteStream ReadableStream<Uint8Array> returned by fetch
+     * @returns ReadableStream<StreamedData> that will be the result of the Command
+     */
+    decodeByteStream(byteStream: ReadableStream<Uint8Array>): ReadableStream<StreamedData>;
+    abstract decodeSSEStream(sseStream: ReadableStream<SSEMessage>): ReadableStream<StreamedData>;
+}
+/**
+ * A TransformStream that parses server-sent event (SSE) data according to the SSE spec:
+ * https://html.spec.whatwg.org/multipage/server-sent-events.html
+ */
+export declare class SSEParsingStream extends TransformStream<string, SSEMessage> {
+    constructor();
+}

package/dist/v1/index.js

@@ -0,0 +1,88 @@
+/*!
+ * Copyright (c) 2022, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+import { StreamingCommand } from "@conduit-client/command-streaming/v1";
+class SSECommand extends StreamingCommand {
+  constructor(services) {
+    super(services);
+    this.services = services;
+  }
+  /**
+   * Decodes the bytes returned by fetch into the correct shape.
+   *
+   * @param byteStream ReadableStream<Uint8Array> returned by fetch
+   * @returns ReadableStream<StreamedData> that will be the result of the Command
+   */
+  decodeByteStream(byteStream) {
+    return this.decodeSSEStream(
+      byteStream.pipeThrough(new TextDecoderStream()).pipeThrough(new SSEParsingStream())
+    );
+  }
+}
+const sseRegex = /^(?<field>[^:]*?)(: ?(?<value>.*?))?(?:\r\n?|\n)/;
+class SSEParsingStream extends TransformStream {
+  constructor() {
+    let ignoreLeadingLF = false, partialLine = "", data = "", event = "", id = "", retry;
+    super({
+      transform(chunk, controller) {
+        if (ignoreLeadingLF && chunk.startsWith("\n")) {
+          chunk = chunk.slice(1);
+        }
+        ignoreLeadingLF = chunk.endsWith("\r");
+        let text = partialLine + chunk;
+        let match;
+        while (match = text.match(sseRegex)) {
+          text = text.slice(match[0].length);
+          if (match.groups.field === "" && match.groups.value === void 0) {
+            if (data === "") {
+              event = "";
+              continue;
+            }
+            if (data.endsWith("\n")) {
+              data = data.slice(0, -1);
+            }
+            const sseMessage = {
+              data,
+              id,
+              // default event value is "message"
+              event: event || "message"
+            };
+            if (retry !== void 0) {
+              sseMessage.retry = retry;
+            }
+            controller.enqueue(sseMessage);
+            data = event = "";
+          } else if (match.groups.field === "data") {
+            data += (match.groups.value || "") + "\n";
+          } else if (match.groups.field === "event") {
+            event = match.groups.value || "";
+          } else if (match.groups.field === "id") {
+            const idValue = match.groups.value || "";
+            if (!idValue.includes("\0")) {
+              id = idValue;
+            }
+          } else if (match.groups.field === "retry") {
+            if (/^\d+$/.exec(match.groups.value)) {
+              retry = parseInt(match.groups.value);
+            }
+          } else ;
+        }
+        partialLine = text;
+      }
+    });
+  }
+}
+function buildServiceDescriptor() {
+  return {
+    type: "SSECommandBaseClass",
+    version: "1.0",
+    service: SSECommand
+  };
+}
+export {
+  SSECommand,
+  buildServiceDescriptor
+};
+//# sourceMappingURL=index.js.map

package/dist/v1/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/v1/sse-command.ts","../../src/v1/index.ts"],"sourcesContent":["import { StreamingCommand } from '@conduit-client/command-streaming/v1';\nimport type { NamedFetchService } from '@conduit-client/service-fetch-network/v1';\n\nexport type SSEMessage = {\n    event: string;\n    data: string;\n    id: string;\n    retry?: number;\n};\n\n/**\n * An implementation of StreamingCommand that handles SSE (Server-Sent Event) streams.\n */\nexport abstract class SSECommand<\n    StreamedData = SSEMessage,\n    ExtraServices extends object = object,\n> extends StreamingCommand<StreamedData, ExtraServices> {\n    constructor(protected services: NamedFetchService & ExtraServices) {\n        super(services);\n    }\n\n    /**\n     * Decodes the bytes returned by fetch into the correct shape.\n     *\n     * @param byteStream ReadableStream<Uint8Array> returned by fetch\n     * @returns ReadableStream<StreamedData> that will be the result of the Command\n     */\n    decodeByteStream(byteStream: ReadableStream<Uint8Array>): ReadableStream<StreamedData> {\n        return this.decodeSSEStream(\n            byteStream\n                // eslint-disable-next-line no-undef\n                .pipeThrough(new TextDecoderStream())\n                .pipeThrough(new SSEParsingStream())\n        );\n    }\n\n    abstract decodeSSEStream(sseStream: ReadableStream<SSEMessage>): ReadableStream<StreamedData>;\n}\n\nconst sseRegex = /^(?<field>[^:]*?)(: ?(?<value>.*?))?(?:\\r\\n?|\\n)/;\n//                 +-------v------++--------v--------++-----v----+\n//                         |                |               |\n//                         |                |        CRLF | CR | LF\n//                         |                |\n//                         |    \": value\", or \": comment\" if no field name (optional)\n//                         |\n//               field name (optional); can be entire line if no \":\"\n\n/**\n * A TransformStream that parses server-sent event (SSE) data according to the SSE spec:\n * https://html.spec.whatwg.org/multipage/server-sent-events.html\n */\nexport class SSEParsingStream extends TransformStream<string, SSEMessage> {\n    constructor() {\n        let ignoreLeadingLF = false,\n            partialLine: string = '',\n            data: string = '',\n            event: string = '',\n            id: string = '',\n            retry: number | undefined;\n\n        super({\n            transform(chunk, controller) {\n                // account for case where chunk boundary splits \\r\\n\n                if (ignoreLeadingLF && chunk.startsWith('\\n')) {\n                    // eslint-disable-next-line no-param-reassign\n                    chunk = chunk.slice(1);\n                }\n                ignoreLeadingLF = chunk.endsWith('\\r');\n\n                // prepend partial last line from previous chunk\n                let text = partialLine + chunk;\n\n                let match: RegExpMatchArray | null;\n                while ((match = text.match(sseRegex))) {\n                    text = text.slice(match[0].length);\n\n                    // blank linke, end of text/event-stream message\n                    if (match.groups!.field === '' && match.groups!.value === undefined) {\n                        // drop messages with no data\n                        if (data === '') {\n                            event = '';\n                            continue;\n                        }\n\n                        // strip trailing \\n from data\n                        if (data.endsWith('\\n')) {\n                            data = data.slice(0, -1);\n                        }\n\n                        const sseMessage: SSEMessage = {\n                            data,\n                            id,\n                            // default event value is \"message\"\n                            event: event || 'message',\n                        };\n\n                        if (retry !== undefined) {\n                            sseMessage.retry = retry;\n                        }\n\n                        controller.enqueue(sseMessage);\n\n                        // clear data & event for next message; id and retry persist until changed\n                        data = event = '';\n                    }\n\n                    // data: line\n                    else if (match.groups!.field === 'data') {\n                        data += (match.groups!.value || '') + '\\n';\n                    }\n\n                    // event: line\n                    else if (match.groups!.field === 'event') {\n                        event = match.groups!.value || '';\n                    }\n\n                    // id: line\n                    else if (match.groups!.field === 'id') {\n                        const idValue = match.groups!.value || '';\n                        if (!idValue.includes('\\u0000')) {\n                            id = idValue;\n                        }\n                    }\n\n                    // retry: line\n                    else if (match.groups!.field === 'retry') {\n                        // ignore bogus values\n                        if (/^\\d+$/.exec(match.groups!.value)) {\n                            retry = parseInt(match.groups!.value);\n                        }\n                    }\n\n                    // comment or unrecognized field, ignore\n                    else {\n                        // do nothing\n                    }\n                }\n\n                // save partial line for next chunk\n                partialLine = text;\n            },\n        });\n    }\n}\n","import { type ServiceDescriptor } from '@conduit-client/utils';\nimport { SSECommand } from './sse-command';\nexport { type SSEMessage } from './sse-command';\n\nexport { SSECommand } from './sse-command';\n\nexport type SSECommandServiceDescriptor = ServiceDescriptor<\n    typeof SSECommand,\n    'SSECommandBaseClass',\n    '1.0'\n>;\n\nexport function buildServiceDescriptor(): SSECommandServiceDescriptor {\n    return {\n        type: 'SSECommandBaseClass',\n        version: '1.0',\n        service: SSECommand,\n    };\n}\n"],"names":[],"mappings":";;;;;;AAaO,MAAe,mBAGZ,iBAA8C;AAAA,EACpD,YAAsB,UAA6C;AAC/D,UAAM,QAAQ;AADI,SAAA,WAAA;AAAA,EAEtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,iBAAiB,YAAsE;AACnF,WAAO,KAAK;AAAA,MACR,WAEK,YAAY,IAAI,kBAAA,CAAmB,EACnC,YAAY,IAAI,iBAAA,CAAkB;AAAA,IAAA;AAAA,EAE/C;AAGJ;AAEA,MAAM,WAAW;AAaV,MAAM,yBAAyB,gBAAoC;AAAA,EACtE,cAAc;AACV,QAAI,kBAAkB,OAClB,cAAsB,IACtB,OAAe,IACf,QAAgB,IAChB,KAAa,IACb;AAEJ,UAAM;AAAA,MACF,UAAU,OAAO,YAAY;AAEzB,YAAI,mBAAmB,MAAM,WAAW,IAAI,GAAG;AAE3C,kBAAQ,MAAM,MAAM,CAAC;AAAA,QACzB;AACA,0BAAkB,MAAM,SAAS,IAAI;AAGrC,YAAI,OAAO,cAAc;AAEzB,YAAI;AACJ,eAAQ,QAAQ,KAAK,MAAM,QAAQ,GAAI;AACnC,iBAAO,KAAK,MAAM,MAAM,CAAC,EAAE,MAAM;AAGjC,cAAI,MAAM,OAAQ,UAAU,MAAM,MAAM,OAAQ,UAAU,QAAW;AAEjE,gBAAI,SAAS,IAAI;AACb,sBAAQ;AACR;AAAA,YACJ;AAGA,gBAAI,KAAK,SAAS,IAAI,GAAG;AACrB,qBAAO,KAAK,MAAM,GAAG,EAAE;AAAA,YAC3B;AAEA,kBAAM,aAAyB;AAAA,cAC3B;AAAA,cACA;AAAA;AAAA,cAEA,OAAO,SAAS;AAAA,YAAA;AAGpB,gBAAI,UAAU,QAAW;AACrB,yBAAW,QAAQ;AAAA,YACvB;AAEA,uBAAW,QAAQ,UAAU;AAG7B,mBAAO,QAAQ;AAAA,UACnB,WAGS,MAAM,OAAQ,UAAU,QAAQ;AACrC,qBAAS,MAAM,OAAQ,SAAS,MAAM;AAAA,UAC1C,WAGS,MAAM,OAAQ,UAAU,SAAS;AACtC,oBAAQ,MAAM,OAAQ,SAAS;AAAA,UACnC,WAGS,MAAM,OAAQ,UAAU,MAAM;AACnC,kBAAM,UAAU,MAAM,OAAQ,SAAS;AACvC,gBAAI,CAAC,QAAQ,SAAS,IAAQ,GAAG;AAC7B,mBAAK;AAAA,YACT;AAAA,UACJ,WAGS,MAAM,OAAQ,UAAU,SAAS;AAEtC,gBAAI,QAAQ,KAAK,MAAM,OAAQ,KAAK,GAAG;AACnC,sBAAQ,SAAS,MAAM,OAAQ,KAAK;AAAA,YACxC;AAAA,UACJ,MAGK;AAAA,QAGT;AAGA,sBAAc;AAAA,MAClB;AAAA,IAAA,CACH;AAAA,EACL;AACJ;ACpIO,SAAS,yBAAsD;AAClE,SAAO;AAAA,IACH,MAAM;AAAA,IACN,SAAS;AAAA,IACT,SAAS;AAAA,EAAA;AAEjB;"}

package/package.json

@@ -0,0 +1,48 @@
+{
+    "name": "@conduit-client/command-sse",
+    "version": "5.67.0-dev1",
+    "private": false,
+    "description": "Luvio SSE Streaming Command",
+    "type": "module",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/salesforce-experience-platform-emu/luvio-next.git",
+        "directory": "packages/@conduit-client/commands/sse"
+    },
+    "license": "SEE LICENSE IN LICENSE.txt",
+    "exports": {
+        "./v1": {
+            "import": "./dist/v1/index.js",
+            "types": "./dist/types/v1/index.d.ts",
+            "require": "./dist/v1/index.js"
+        }
+    },
+    "main": "./dist/main/index.js",
+    "module": "./dist/main/index.js",
+    "types": "./dist/main/index.d.ts",
+    "files": [
+        "dist/"
+    ],
+    "scripts": {
+        "build": "vite build && tsc --build --emitDeclarationOnly",
+        "clean": "rm -rf dist",
+        "test": "vitest run",
+        "test:size": "size-limit",
+        "watch": "npm run build --watch"
+    },
+    "dependencies": {
+        "@conduit-client/command-base": "5.67.0-dev1",
+        "@conduit-client/command-streaming": "5.67.0-dev1",
+        "@conduit-client/service-fetch-network": "5.67.0-dev1",
+        "@conduit-client/utils": "5.67.0-dev1"
+    },
+    "volta": {
+        "extends": "../../../../package.json"
+    },
+    "size-limit": [
+        {
+            "path": "./dist/v1/index.js",
+            "limit": "2 kB"
+        }
+    ]
+}