@conduit-client/service-provisioner 2.0.0

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/index.d.ts

@@ -0,0 +1,78 @@
+import { type ServiceDescriptor } from '@conduit-client/utils';
+/**
+ * When a service instance is registered it can have additional tags associated with it.
+ * Service consumers can use these tags to discriminate among otherwise equivalent
+ * instances of the service.
+ */
+export type PublishedService = ServiceDescriptor<unknown> & {
+    tags?: Record<string, string>;
+};
+/**
+ * A request for a required single service.
+ */
+export type ServiceRequest<D extends ServiceDescriptor<unknown>> = Omit<D, 'service'> & {
+    tags?: Record<string, string>;
+};
+/**
+ * A request for an optional single service.
+ */
+export type OptionalServiceRequest<D extends ServiceDescriptor<unknown>> = ServiceRequest<D> & {
+    optional: true;
+};
+/**
+ * A request for a set of services.
+ */
+export type ServicesRequest<D extends ServiceDescriptor<unknown>, Name extends string = D['type']> = Record<Name, ServiceRequest<D> | OptionalServiceRequest<D>>;
+/**
+ * Utility type to extract the service implementation type from a ServiceRequest.
+ */
+export type RequestedService<R extends ServiceRequest<any>> = R extends OptionalServiceRequest<ServiceDescriptor<infer S>> ? S | undefined : R extends ServiceRequest<ServiceDescriptor<infer S>> ? S : never;
+/**
+ * A map of services that matches a given ServicesRequest.
+ */
+export type RequestedServices<R extends ServicesRequest<any>> = {
+    [k in keyof R]: RequestedService<R[k]>;
+};
+/**
+ * Attempts to resolve a set of requested services against a set of published services.
+ * Returns a map of the requested services if the published services satisfy the request;
+ * undefined if published services are missing one or more of the requested services.
+ *
+ * Note that this function is exported ONLY for use by runtime environments that need to
+ * override the default getServices() implementation below. Service consumers should only
+ * use the default export to request the services they need.
+ *
+ * @param published published services
+ * @param requested requested services
+ * @returns service map if published satisfies requests; undefined if not
+ */
+export declare function resolve<R extends ServicesRequest<ServiceDescriptor<unknown>>>(published: PublishedService[], requested: R): RequestedServices<R> | undefined;
+/**
+ * Requests a given set of services from the runtime environment.
+ *
+ * The default implementation of this function guarantees that the return
+ * PromiseLike will be resolved synchronously. That is, one of the functions
+ * supplied to its .then() will be invoked before .then() returns. Overrides
+ * of this function SHOULD preserve this behavior whenever possible, as
+ * some service consumer initialization patterns cannot support asynchronous
+ * initialization of services.
+ *
+ * @param request requested services
+ * @returns PromiseLike for the requested services; rejects if the requested
+ *    services are not available
+ */
+export default function getServices<R extends ServicesRequest<any>>(request: R, timeout?: number): PromiseLike<RequestedServices<R>>;
+/**
+ * Sets the services that will be used to satisfy calls to getServices().
+ * Any previously registered services are replaced with the services provided.
+ * Note overwriting services should be done with great care as previous callers
+ * of getServices() will not be aware of the new services.
+ *
+ * The default implementation provided by this module only supports a single
+ * set of active services. Runtime environments that require multiple sets of
+ * active services will need to override this module with their own
+ * implementation.
+ 
+ * @param services services to be used to satisfy future getServices() requests
+ */
+export declare function setServices(services: PublishedService[]): void;

package/dist/v1/index.js

@@ -0,0 +1,66 @@
+/*!
+ * Copyright (c) 2022, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+import { racesync, satisfies, resolvedPromiseLike } from "@conduit-client/utils";
+function resolve(published, requested) {
+  const result = {};
+  for (const [name, request] of Object.entries(requested)) {
+    const matchingService = published.find(
+      (s) => (
+        // service types must match
+        s.type === request.type && // version of the service must satisfy the requested version
+        satisfies(s.version, request.version) && // no tags requested, or the service matches every requested tag value
+        (request.tags === void 0 || Object.keys(request.tags).every((tag) => {
+          var _a;
+          return ((_a = s.tags) == null ? void 0 : _a[tag]) === request.tags[tag];
+        }))
+      )
+    );
+    if (matchingService) {
+      result[name] = matchingService.service;
+    } else if (!("optional" in request && request.optional)) {
+      return;
+    }
+  }
+  return result;
+}
+let servicesAvailable;
+let waitForServices = new Promise(
+  (resolve2) => servicesAvailable = resolve2
+);
+function getServices(request, timeout = 3e4) {
+  const servicesPromise = waitForServices.then((services) => {
+    const result = resolve(services, request);
+    if (result) {
+      return result;
+    }
+    throw new Error("no matches found for one or more requested services");
+  });
+  let timeoutId;
+  let timeoutPromise = new Promise((_, reject) => {
+    timeoutId = setTimeout(() => reject(new Error("OneStore services unavailable")), timeout);
+  });
+  return racesync([servicesPromise, timeoutPromise]).then(
+    (value) => {
+      clearTimeout(timeoutId);
+      return value;
+    },
+    (reason) => {
+      clearTimeout(timeoutId);
+      console.error(reason);
+      throw reason;
+    }
+  );
+}
+function setServices(services) {
+  waitForServices = resolvedPromiseLike(services);
+  servicesAvailable(services);
+}
+export {
+  getServices as default,
+  resolve,
+  setServices
+};
+//# sourceMappingURL=index.js.map

package/dist/v1/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/v1/index.ts"],"sourcesContent":["import {\n    resolvedPromiseLike,\n    racesync,\n    satisfies,\n    type ServiceDescriptor,\n} from '@conduit-client/utils';\n\n/**\n * When a service instance is registered it can have additional tags associated with it.\n * Service consumers can use these tags to discriminate among otherwise equivalent\n * instances of the service.\n */\nexport type PublishedService = ServiceDescriptor<unknown> & {\n    tags?: Record<string, string>;\n};\n\n/**\n * A request for a required single service.\n */\nexport type ServiceRequest<D extends ServiceDescriptor<unknown>> = Omit<D, 'service'> & {\n    tags?: Record<string, string>;\n};\n\n/**\n * A request for an optional single service.\n */\nexport type OptionalServiceRequest<D extends ServiceDescriptor<unknown>> = ServiceRequest<D> & {\n    optional: true;\n};\n\n/**\n * A request for a set of services.\n */\nexport type ServicesRequest<\n    D extends ServiceDescriptor<unknown>,\n    Name extends string = D['type'],\n> = Record<Name, ServiceRequest<D> | OptionalServiceRequest<D>>;\n\n/**\n * Utility type to extract the service implementation type from a ServiceRequest.\n */\nexport type RequestedService<R extends ServiceRequest<any>> =\n    R extends OptionalServiceRequest<ServiceDescriptor<infer S>>\n        ? S | undefined\n        : R extends ServiceRequest<ServiceDescriptor<infer S>>\n          ? S\n          : never;\n\n/**\n * A map of services that matches a given ServicesRequest.\n */\nexport type RequestedServices<R extends ServicesRequest<any>> = {\n    [k in keyof R]: RequestedService<R[k]>;\n};\n\n/**\n * Attempts to resolve a set of requested services against a set of published services.\n * Returns a map of the requested services if the published services satisfy the request;\n * undefined if published services are missing one or more of the requested services.\n *\n * Note that this function is exported ONLY for use by runtime environments that need to\n * override the default getServices() implementation below. Service consumers should only\n * use the default export to request the services they need.\n *\n * @param published published services\n * @param requested requested services\n * @returns service map if published satisfies requests; undefined if not\n */\nexport function resolve<R extends ServicesRequest<ServiceDescriptor<unknown>>>(\n    published: PublishedService[],\n    requested: R\n): RequestedServices<R> | undefined {\n    const result: RequestedServices<R> = {} as any;\n\n    for (const [name, request] of Object.entries(requested)) {\n        const matchingService = published.find(\n            (s) =>\n                // service types must match\n                s.type === request.type &&\n                // version of the service must satisfy the requested version\n                satisfies(s.version, request.version) &&\n                // no tags requested, or the service matches every requested tag value\n                (request.tags === undefined ||\n                    Object.keys(request.tags).every((tag) => s.tags?.[tag] === request.tags![tag]))\n        );\n\n        if (matchingService) {\n            (result as any)[name] = matchingService.service;\n        } else if (!('optional' in request && request.optional)) {\n            return;\n        }\n    }\n\n    return result;\n}\n\n/**\n * Most-recently set of published services.\n */\nlet servicesAvailable: (services: PublishedService[]) => void;\nlet waitForServices: PromiseLike<PublishedService[]> = new Promise<PublishedService[]>(\n    (resolve) => (servicesAvailable = resolve)\n);\n\n/**\n * Requests a given set of services from the runtime environment.\n *\n * The default implementation of this function guarantees that the return\n * PromiseLike will be resolved synchronously. That is, one of the functions\n * supplied to its .then() will be invoked before .then() returns. Overrides\n * of this function SHOULD preserve this behavior whenever possible, as\n * some service consumer initialization patterns cannot support asynchronous\n * initialization of services.\n *\n * @param request requested services\n * @returns PromiseLike for the requested services; rejects if the requested\n *    services are not available\n */\nexport default function getServices<R extends ServicesRequest<any>>(\n    request: R,\n    timeout: number = 30000\n): PromiseLike<RequestedServices<R>> {\n    const servicesPromise = waitForServices.then((services) => {\n        // try to resolve the requested services against our services\n        const result = resolve(services, request);\n\n        // resolve/reject based on whether we have all the requested services\n        if (result) {\n            return result;\n        }\n\n        throw new Error('no matches found for one or more requested services');\n    });\n\n    let timeoutId: ReturnType<typeof setTimeout>;\n    let timeoutPromise = new Promise<never>((_, reject) => {\n        timeoutId = setTimeout(() => reject(new Error('OneStore services unavailable')), timeout);\n    });\n\n    return racesync([servicesPromise, timeoutPromise]).then(\n        (value) => {\n            clearTimeout(timeoutId);\n            return value;\n        },\n        (reason) => {\n            clearTimeout(timeoutId);\n            // eslint-disable-next-line\n            console.error(reason);\n            throw reason;\n        }\n    );\n}\n\n/**\n * Sets the services that will be used to satisfy calls to getServices().\n * Any previously registered services are replaced with the services provided.\n * Note overwriting services should be done with great care as previous callers\n * of getServices() will not be aware of the new services.\n * \n * The default implementation provided by this module only supports a single\n * set of active services. Runtime environments that require multiple sets of\n * active services will need to override this module with their own\n * implementation.\n \n * @param services services to be used to satisfy future getServices() requests\n */\nexport function setServices(services: PublishedService[]) {\n    waitForServices = resolvedPromiseLike(services);\n    servicesAvailable(services);\n}\n"],"names":["resolve"],"mappings":";;;;;;AAoEO,SAAS,QACZ,WACA,WACgC;AAChC,QAAM,SAA+B,CAAA;AAErC,aAAW,CAAC,MAAM,OAAO,KAAK,OAAO,QAAQ,SAAS,GAAG;AACrD,UAAM,kBAAkB,UAAU;AAAA,MAC9B,CAAC;AAAA;AAAA,QAEG,EAAE,SAAS,QAAQ;AAAA,QAEnB,UAAU,EAAE,SAAS,QAAQ,OAAO;AAAA,SAEnC,QAAQ,SAAS,UACd,OAAO,KAAK,QAAQ,IAAI,EAAE,MAAM,CAAC,QAAA;;AAAQ,0BAAE,SAAF,mBAAS,UAAS,QAAQ,KAAM,GAAG;AAAA,SAAC;AAAA;AAAA,IAAA;AAGzF,QAAI,iBAAiB;AAChB,aAAe,IAAI,IAAI,gBAAgB;AAAA,IAC5C,WAAW,EAAE,cAAc,WAAW,QAAQ,WAAW;AACrD;AAAA,IACJ;AAAA,EACJ;AAEA,SAAO;AACX;AAKA,IAAI;AACJ,IAAI,kBAAmD,IAAI;AAAA,EACvD,CAACA,aAAa,oBAAoBA;AACtC;AAgBA,SAAwB,YACpB,SACA,UAAkB,KACe;AACjC,QAAM,kBAAkB,gBAAgB,KAAK,CAAC,aAAa;AAEvD,UAAM,SAAS,QAAQ,UAAU,OAAO;AAGxC,QAAI,QAAQ;AACR,aAAO;AAAA,IACX;AAEA,UAAM,IAAI,MAAM,qDAAqD;AAAA,EACzE,CAAC;AAED,MAAI;AACJ,MAAI,iBAAiB,IAAI,QAAe,CAAC,GAAG,WAAW;AACnD,gBAAY,WAAW,MAAM,OAAO,IAAI,MAAM,+BAA+B,CAAC,GAAG,OAAO;AAAA,EAC5F,CAAC;AAED,SAAO,SAAS,CAAC,iBAAiB,cAAc,CAAC,EAAE;AAAA,IAC/C,CAAC,UAAU;AACP,mBAAa,SAAS;AACtB,aAAO;AAAA,IACX;AAAA,IACA,CAAC,WAAW;AACR,mBAAa,SAAS;AAEtB,cAAQ,MAAM,MAAM;AACpB,YAAM;AAAA,IACV;AAAA,EAAA;AAER;AAeO,SAAS,YAAY,UAA8B;AACtD,oBAAkB,oBAAoB,QAAQ;AAC9C,oBAAkB,QAAQ;AAC9B;"}

package/package.json

@@ -0,0 +1,45 @@
+{
+    "name": "@conduit-client/service-provisioner",
+    "version": "2.0.0",
+    "private": false,
+    "description": "Luvio Service Provisioner",
+    "type": "module",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/salesforce-experience-platform-emu/luvio-next.git",
+        "directory": "packages/@conduit-client/service-provisioner"
+    },
+    "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/utils": "2.0.0"
+    },
+    "volta": {
+        "extends": "../../../package.json"
+    },
+    "size-limit": [
+        {
+            "path": "./dist/v1/index.js",
+            "limit": "720 B"
+        }
+    ]
+}