@conduit-client/bindings-utils 3.7.1 → 3.9.0

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

@@ -1,5 +1,6 @@
 import { Command } from '@conduit-client/command-base/v1';
 import { Result, SyncOrAsync, SubscribableResult, Callback, IInternalError, IUserVisibleError } from '@conduit-client/utils';
+import { type RequestedServices, type ServicesRequest } from '@conduit-client/service-provisioner/v1';
 export type ResultOrSubscribableResult<Data, Error = unknown> = Result<Data, Error> | SubscribableResult<Data, Error>;
 export type MaybeSubscribableResultCommand<Data, Error = unknown> = Command<SyncOrAsync<ResultOrSubscribableResult<Data, Error>>>;
 export type SubscribableResultCommand<Data, Error = unknown, Params extends Array<any> = []> = Command<SyncOrAsync<SubscribableResult<Data, Error>>, Params>;
@@ -10,3 +11,20 @@ export declare function throwUserlandError(error: unknown): never;
 export declare function emitError(callback: Callback<any>, error: unknown): void;
 export declare function buildUserlandError(error: unknown): Error;
 export declare function logError(error: unknown): void;
+export type InitBindingsExportsArgs<Req extends ServicesRequest<any>, TExports extends object> = {
+    serviceRequirements: Req;
+    exports: TExports;
+    init: (services: RequestedServices<Req>, exports: TExports) => void;
+    timeout?: number;
+};
+/**
+ * Bootstraps a bindings exports map by requesting services from the service provisioner and
+ * invoking a generated (or custom) initializer to populate exports.
+ *
+ * This is intended to make generated code extensible: custom modules can compose exports and
+ * then call this function once, without needing to enumerate every generated export.
+ */
+export declare function initBindingsExports<Req extends ServicesRequest<any>, TExports extends object>(args: InitBindingsExportsArgs<Req, TExports>): {
+    exports: TExports;
+    ready: PromiseLike<void>;
+};

package/dist/v1/index.js

@@ -3,6 +3,7 @@
  * All rights reserved.
  * For full license text, see the LICENSE.txt file
  */
+import getServices from "@conduit-client/service-provisioner/v1";
 function isInternalError(error) {
   return error instanceof Error && "type" in error && error.type === "internal";
 }
@@ -29,9 +30,17 @@ function logError(error) {
   }
   console.error("OneStore Command threw an error that we did not expect", error);
 }
+function initBindingsExports(args) {
+  const { serviceRequirements, exports: exports$1, init, timeout } = args;
+  const ready = getServices(serviceRequirements, timeout).then((services) => {
+    init(services, exports$1);
+  });
+  return { exports: exports$1, ready };
+}
 export {
   buildUserlandError,
   emitError,
+  initBindingsExports,
   isInternalError,
   isUserVisibleError,
   logError,

package/dist/v1/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../src/v1/utils.ts"],"sourcesContent":["import { Command } from '@conduit-client/command-base/v1';\nimport {\n    Result,\n    SyncOrAsync,\n    SubscribableResult,\n    Callback,\n    IInternalError,\n    IUserVisibleError,\n} from '@conduit-client/utils';\n\nexport type ResultOrSubscribableResult<Data, Error = unknown> =\n    | Result<Data, Error>\n    | SubscribableResult<Data, Error>;\n\nexport type MaybeSubscribableResultCommand<Data, Error = unknown> = Command<\n    SyncOrAsync<ResultOrSubscribableResult<Data, Error>>\n>;\n\nexport type SubscribableResultCommand<\n    Data,\n    Error = unknown,\n    Params extends Array<any> = [],\n> = Command<SyncOrAsync<SubscribableResult<Data, Error>>, Params>;\n\nexport type ResultCommand<Data, Error = unknown> = Command<SyncOrAsync<Result<Data, Error>>>;\n\nexport function isInternalError<Data = undefined>(error: unknown): error is IInternalError<Data> {\n    return error instanceof Error && 'type' in error && error.type === 'internal';\n}\n\nexport function isUserVisibleError<Data = undefined>(\n    error: unknown\n): error is IUserVisibleError<Data> {\n    return error instanceof Error && 'type' in error && error.type === 'user-visible';\n}\n\nexport function throwUserlandError(error: unknown): never {\n    logError(error);\n    throw buildUserlandError(error);\n}\n\nexport function emitError(callback: Callback<any>, error: unknown): void {\n    logError(error);\n    callback({ data: undefined, error: buildUserlandError(error) });\n}\n\nexport function buildUserlandError(error: unknown): Error {\n    if (isUserVisibleError<Error>(error)) {\n        return error.data;\n    }\n\n    return new Error('Internal error in Lightning Data Service adapter occurred.');\n}\n\nexport function logError(error: unknown): void {\n    if (isUserVisibleError(error)) {\n        return;\n    }\n\n    console.error('OneStore Command threw an error that we did not expect', error);\n}\n"],"names":[],"mappings":";;;;;AA0BO,SAAS,gBAAkC,OAA+C;AAC7F,SAAO,iBAAiB,SAAS,UAAU,SAAS,MAAM,SAAS;AACvE;AAEO,SAAS,mBACZ,OACgC;AAChC,SAAO,iBAAiB,SAAS,UAAU,SAAS,MAAM,SAAS;AACvE;AAEO,SAAS,mBAAmB,OAAuB;AACtD,WAAS,KAAK;AACd,QAAM,mBAAmB,KAAK;AAClC;AAEO,SAAS,UAAU,UAAyB,OAAsB;AACrE,WAAS,KAAK;AACd,WAAS,EAAE,MAAM,QAAW,OAAO,mBAAmB,KAAK,GAAG;AAClE;AAEO,SAAS,mBAAmB,OAAuB;AACtD,MAAI,mBAA0B,KAAK,GAAG;AAClC,WAAO,MAAM;AAAA,EACjB;AAEA,SAAO,IAAI,MAAM,4DAA4D;AACjF;AAEO,SAAS,SAAS,OAAsB;AAC3C,MAAI,mBAAmB,KAAK,GAAG;AAC3B;AAAA,EACJ;AAEA,UAAQ,MAAM,0DAA0D,KAAK;AACjF;"}
+{"version":3,"file":"index.js","sources":["../../src/v1/utils.ts"],"sourcesContent":["import { Command } from '@conduit-client/command-base/v1';\nimport {\n    Result,\n    SyncOrAsync,\n    SubscribableResult,\n    Callback,\n    IInternalError,\n    IUserVisibleError,\n} from '@conduit-client/utils';\nimport getServices, {\n    type RequestedServices,\n    type ServicesRequest,\n} from '@conduit-client/service-provisioner/v1';\n\nexport type ResultOrSubscribableResult<Data, Error = unknown> =\n    | Result<Data, Error>\n    | SubscribableResult<Data, Error>;\n\nexport type MaybeSubscribableResultCommand<Data, Error = unknown> = Command<\n    SyncOrAsync<ResultOrSubscribableResult<Data, Error>>\n>;\n\nexport type SubscribableResultCommand<\n    Data,\n    Error = unknown,\n    Params extends Array<any> = [],\n> = Command<SyncOrAsync<SubscribableResult<Data, Error>>, Params>;\n\nexport type ResultCommand<Data, Error = unknown> = Command<SyncOrAsync<Result<Data, Error>>>;\n\nexport function isInternalError<Data = undefined>(error: unknown): error is IInternalError<Data> {\n    return error instanceof Error && 'type' in error && error.type === 'internal';\n}\n\nexport function isUserVisibleError<Data = undefined>(\n    error: unknown\n): error is IUserVisibleError<Data> {\n    return error instanceof Error && 'type' in error && error.type === 'user-visible';\n}\n\nexport function throwUserlandError(error: unknown): never {\n    logError(error);\n    throw buildUserlandError(error);\n}\n\nexport function emitError(callback: Callback<any>, error: unknown): void {\n    logError(error);\n    callback({ data: undefined, error: buildUserlandError(error) });\n}\n\nexport function buildUserlandError(error: unknown): Error {\n    if (isUserVisibleError<Error>(error)) {\n        return error.data;\n    }\n\n    return new Error('Internal error in Lightning Data Service adapter occurred.');\n}\n\nexport function logError(error: unknown): void {\n    if (isUserVisibleError(error)) {\n        return;\n    }\n\n    console.error('OneStore Command threw an error that we did not expect', error);\n}\n\nexport type InitBindingsExportsArgs<Req extends ServicesRequest<any>, TExports extends object> = {\n    serviceRequirements: Req;\n    exports: TExports;\n    init: (services: RequestedServices<Req>, exports: TExports) => void;\n    timeout?: number;\n};\n\n/**\n * Bootstraps a bindings exports map by requesting services from the service provisioner and\n * invoking a generated (or custom) initializer to populate exports.\n *\n * This is intended to make generated code extensible: custom modules can compose exports and\n * then call this function once, without needing to enumerate every generated export.\n */\nexport function initBindingsExports<Req extends ServicesRequest<any>, TExports extends object>(\n    args: InitBindingsExportsArgs<Req, TExports>\n): { exports: TExports; ready: PromiseLike<void> } {\n    const { serviceRequirements, exports, init, timeout } = args;\n\n    const ready = getServices(serviceRequirements, timeout).then((services) => {\n        init(services, exports);\n    });\n\n    return { exports, ready };\n}\n"],"names":["exports"],"mappings":";;;;;;AA8BO,SAAS,gBAAkC,OAA+C;AAC7F,SAAO,iBAAiB,SAAS,UAAU,SAAS,MAAM,SAAS;AACvE;AAEO,SAAS,mBACZ,OACgC;AAChC,SAAO,iBAAiB,SAAS,UAAU,SAAS,MAAM,SAAS;AACvE;AAEO,SAAS,mBAAmB,OAAuB;AACtD,WAAS,KAAK;AACd,QAAM,mBAAmB,KAAK;AAClC;AAEO,SAAS,UAAU,UAAyB,OAAsB;AACrE,WAAS,KAAK;AACd,WAAS,EAAE,MAAM,QAAW,OAAO,mBAAmB,KAAK,GAAG;AAClE;AAEO,SAAS,mBAAmB,OAAuB;AACtD,MAAI,mBAA0B,KAAK,GAAG;AAClC,WAAO,MAAM;AAAA,EACjB;AAEA,SAAO,IAAI,MAAM,4DAA4D;AACjF;AAEO,SAAS,SAAS,OAAsB;AAC3C,MAAI,mBAAmB,KAAK,GAAG;AAC3B;AAAA,EACJ;AAEA,UAAQ,MAAM,0DAA0D,KAAK;AACjF;AAgBO,SAAS,oBACZ,MAC+C;AAC/C,QAAM,EAAE,qBAAA,SAAqBA,WAAS,MAAM,YAAY;AAExD,QAAM,QAAQ,YAAY,qBAAqB,OAAO,EAAE,KAAK,CAAC,aAAa;AACvE,SAAK,UAAUA,SAAO;AAAA,EAC1B,CAAC;AAED,SAAO,EAAA,SAAEA,WAAS,MAAA;AACtB;"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@conduit-client/bindings-utils",
-    "version": "3.7.1",
+    "version": "3.9.0",
     "private": false,
     "description": "Conduit utils for building bindings consistently",
     "type": "module",
@@ -31,16 +31,17 @@
         "watch": "npm run build --watch"
     },
     "dependencies": {
-        "@conduit-client/command-base": "3.7.1",
-        "@conduit-client/utils": "3.7.1"
+        "@conduit-client/command-base": "3.9.0",
+        "@conduit-client/service-provisioner": "3.9.0",
+        "@conduit-client/utils": "3.9.0"
     },
     "volta": {
-        "extends": "../../../../package.json"
+        "extends": "../../../package.json"
     },
     "size-limit": [
         {
             "path": "./dist/v1/index.js",
-            "limit": "500 B"
+            "limit": "2 KB"
         }
     ]
 }