@wix/auto_sdk_apps-installer_apps-installer 1.0.3 → 1.0.5

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { Tenant, InstallAppOptions, InstallAppResponse, InstallAppApplicationErrors, UninstallAppOptions, BulkUninstallAppOptions, BulkUninstallAppResponse, InstallAppFromShareUrlOptions, InstallAppFromShareUrlResponse, InstallAppFromShareUrlApplicationErrors, InstallTypeWithLiterals, IsPermittedToInstallAppsOptions, IsPermittedToInstallAppsResponse, IsPermittedToInstallAppsApplicationErrors, GetInstalledAppsResponse, AppInstanceAppInstalledOnTenantEnvelope } from './index.typings.js';
-export { ActionEvent, AppInstalledOnTenant, AppInstance, ApplicationError, AppsInstallOptions, BaseEventMetadata, BulkActionMetadata, BulkInstallAppRequest, BulkInstallAppResponse, BulkInstallAppResult, BulkUninstallAppRequest, BulkUninstallAppResult, ClientSpec, ClientSpecMap, DevVersionInstallation, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, GetInstalledAppsRequest, GluedOptions, GluedWidget, IdentificationData, IdentificationDataIdOneOf, InstallAppFromShareUrlRequest, InstallAppRequest, InstallDefaultAppsEvent, InstallType, IsPermittedToInstallAppsOptionsOptionsOneOf, IsPermittedToInstallAppsRequest, IsPermittedToInstallAppsRequestOptionsOneOf, ItemMetadata, LegacyParams, ListAppInstancesRequest, ListAppInstancesResponse, MessageEnvelope, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, ShareUrlInstallOptions, Status, StatusWithLiterals, TPAAppPage, TPAAppRequirements, TPAPermissions, TPASettingsClientSpec, TPAWidgetPosition, TenantType, TenantTypeWithLiterals, UninstallAppRequest, UninstallAppResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, Widget } from './index.typings.js';
+import { Tenant, InstallAppOptions, InstallAppResponse, InstallAppApplicationErrors, BulkInstallAppOptions, BulkInstallAppResponse, BulkInstallAppApplicationErrors, UninstallAppOptions, BulkUninstallAppOptions, BulkUninstallAppResponse, InstallAppFromShareUrlOptions, InstallAppFromShareUrlResponse, InstallAppFromShareUrlApplicationErrors, InstallTypeWithLiterals, IsPermittedToInstallAppsOptions, IsPermittedToInstallAppsResponse, IsPermittedToInstallAppsApplicationErrors, GetInstalledAppsResponse, AppInstanceAppInstalledOnTenantEnvelope } from './index.typings.js';
+export { ActionEvent, AppInstalledOnTenant, AppInstance, ApplicationError, AppsInstallOptions, BaseEventMetadata, BulkActionMetadata, BulkInstallAppRequest, BulkInstallAppResult, BulkUninstallAppRequest, BulkUninstallAppResult, ClientSpec, ClientSpecMap, DevVersionInstallation, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, GetInstalledAppsRequest, GluedOptions, GluedWidget, IdentificationData, IdentificationDataIdOneOf, InstallAppFromShareUrlRequest, InstallAppRequest, InstallDefaultAppsEvent, InstallType, IsPermittedToInstallAppsOptionsOptionsOneOf, IsPermittedToInstallAppsRequest, IsPermittedToInstallAppsRequestOptionsOneOf, ItemMetadata, LegacyParams, ListAppInstancesRequest, ListAppInstancesResponse, MessageEnvelope, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, ShareUrlInstallOptions, Status, StatusWithLiterals, TPAAppPage, TPAAppRequirements, TPAPermissions, TPASettingsClientSpec, TPAWidgetPosition, TenantType, TenantTypeWithLiterals, UninstallAppRequest, UninstallAppResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, Widget } from './index.typings.js';
 
 declare function installApp$1(httpClient: HttpClient): InstallAppSignature;
 interface InstallAppSignature {
@@ -28,6 +28,32 @@ interface InstallAppSignature {
         __applicationErrorsType?: InstallAppApplicationErrors;
     }>;
 }
+declare function bulkInstallApp$1(httpClient: HttpClient): BulkInstallAppSignature;
+interface BulkInstallAppSignature {
+    /**
+     * <blockquote class="warning">
+     *
+     * __Warning:__
+     * By using this API to install 3rd-party apps, you acknowledge and agree that:
+     *
+     * - Some 3rd-party apps installed with this API may access, use, copy, change, or delete all your website's data, including your and your website visitors' and members' financial and personal information.
+     * - Wix may not have reviewed the app, and can't guarantee their operation or that it will continue to function as described by the app developers.
+     * - You may be sharing sensitive information with the app. Review the terms of use and privacy policies of any app you choose to install to understand how your data will be handled.
+     * - You agree to the Wix App Market [terms of use](https://www.wix.com/about/app-market-terms).
+     *
+     * By installing any 3rd-party app through this API, you confirm your acceptance of all the above conditions.
+     *
+     * </blockquote>
+     *
+     * Bulk installs apps on a tenant, specifying the details of the app instances to create.
+     *
+     * The IDs of these app instances are automatically generated and included in the `appInstance` objects in the response.
+     * @param - Tenant details.
+     */
+    (tenant: NonNullablePaths<Tenant, `_id`, 2>, options?: BulkInstallAppOptions): Promise<NonNullablePaths<BulkInstallAppResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.appInstance._id` | `results.${number}.appInstance.appDefId` | `results.${number}.appInstance.enabled` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
+        __applicationErrorsType?: BulkInstallAppApplicationErrors;
+    }>;
+}
 declare function uninstallApp$1(httpClient: HttpClient): UninstallAppSignature;
 interface UninstallAppSignature {
     /**
@@ -90,6 +116,7 @@ interface GetInstalledAppsSignature {
 declare const onAppInstanceAppInstalledOnTenant$1: EventDefinition<AppInstanceAppInstalledOnTenantEnvelope, "wix.apps.v1.app_instance_app_installed_on_tenant">;
 
 declare const installApp: MaybeContext<BuildRESTFunction<typeof installApp$1> & typeof installApp$1>;
+declare const bulkInstallApp: MaybeContext<BuildRESTFunction<typeof bulkInstallApp$1> & typeof bulkInstallApp$1>;
 declare const uninstallApp: MaybeContext<BuildRESTFunction<typeof uninstallApp$1> & typeof uninstallApp$1>;
 declare const bulkUninstallApp: MaybeContext<BuildRESTFunction<typeof bulkUninstallApp$1> & typeof bulkUninstallApp$1>;
 declare const installAppFromShareUrl: MaybeContext<BuildRESTFunction<typeof installAppFromShareUrl$1> & typeof installAppFromShareUrl$1>;
@@ -98,4 +125,4 @@ declare const getInstalledApps: MaybeContext<BuildRESTFunction<typeof getInstall
 /** */
 declare const onAppInstanceAppInstalledOnTenant: BuildEventDefinition<typeof onAppInstanceAppInstalledOnTenant$1> & typeof onAppInstanceAppInstalledOnTenant$1;
 
-export { AppInstanceAppInstalledOnTenantEnvelope, BulkUninstallAppOptions, BulkUninstallAppResponse, GetInstalledAppsResponse, InstallAppApplicationErrors, InstallAppFromShareUrlApplicationErrors, InstallAppFromShareUrlOptions, InstallAppFromShareUrlResponse, InstallAppOptions, InstallAppResponse, InstallTypeWithLiterals, IsPermittedToInstallAppsApplicationErrors, IsPermittedToInstallAppsOptions, IsPermittedToInstallAppsResponse, Tenant, UninstallAppOptions, bulkUninstallApp, getInstalledApps, installApp, installAppFromShareUrl, isPermittedToInstallApps, onAppInstanceAppInstalledOnTenant, uninstallApp };
+export { AppInstanceAppInstalledOnTenantEnvelope, BulkInstallAppApplicationErrors, BulkInstallAppOptions, BulkInstallAppResponse, BulkUninstallAppOptions, BulkUninstallAppResponse, GetInstalledAppsResponse, InstallAppApplicationErrors, InstallAppFromShareUrlApplicationErrors, InstallAppFromShareUrlOptions, InstallAppFromShareUrlResponse, InstallAppOptions, InstallAppResponse, InstallTypeWithLiterals, IsPermittedToInstallAppsApplicationErrors, IsPermittedToInstallAppsOptions, IsPermittedToInstallAppsResponse, Tenant, UninstallAppOptions, bulkInstallApp, bulkUninstallApp, getInstalledApps, installApp, installAppFromShareUrl, isPermittedToInstallApps, onAppInstanceAppInstalledOnTenant, uninstallApp };

package/build/cjs/index.js

@@ -25,6 +25,7 @@ __export(index_exports, {
   Status: () => Status,
   TenantType: () => TenantType,
   WebhookIdentityType: () => WebhookIdentityType,
+  bulkInstallApp: () => bulkInstallApp4,
   bulkUninstallApp: () => bulkUninstallApp4,
   getInstalledApps: () => getInstalledApps4,
   installApp: () => installApp4,
@@ -119,6 +120,12 @@ function resolveWixDevcenterAppsInstallerV1AppsInstallerServiceUrl(opts) {
         srcPath: "/_api/apps-installer-service",
         destPath: ""
       }
+    ],
+    "vibe._base_domain_": [
+      {
+        srcPath: "/_api/apps-installer-service",
+        destPath: ""
+      }
     ]
   };
   return (0, import_rest_modules2.resolveUrl)(Object.assign(opts, { domainToMappings }));
@@ -140,6 +147,9 @@ function installApp(payload) {
       method: "POST",
       methodFqn: "wix.devcenter.apps.installer.v1.AppsInstallerService.InstallApp",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixDevcenterAppsInstallerV1AppsInstallerServiceUrl({
         protoPath: "/v1/app-instance/install",
         data: serializedData,
@@ -162,6 +172,56 @@ function installApp(payload) {
   }
   return __installApp;
 }
+function bulkInstallApp(payload) {
+  function __bulkInstallApp({ host }) {
+    const serializedData = (0, import_transform_paths.transformPaths)(payload, [
+      {
+        transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
+        paths: [
+          { path: "appInstances.installedDate" },
+          { path: "appInstances.updatedDate" }
+        ]
+      }
+    ]);
+    const metadata = {
+      entityFqdn: "wix.apps.v1.app_instance",
+      method: "POST",
+      methodFqn: "wix.devcenter.apps.installer.v1.AppsInstallerService.BulkInstallApp",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixDevcenterAppsInstallerV1AppsInstallerServiceUrl({
+        protoPath: "/v1/bulk/app-instance/install",
+        data: serializedData,
+        host
+      }),
+      data: serializedData,
+      transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
+        {
+          transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "results.appInstance.installedDate" },
+            { path: "results.appInstance.updatedDate" }
+          ]
+        },
+        {
+          transformFn: import_float.transformRESTFloatToSDKFloat,
+          paths: [
+            {
+              path: "clientSpecMap.data.widgets.*.gluedOptions.verticalMargin"
+            },
+            {
+              path: "clientSpecMap.data.widgets.*.gluedOptions.horizontalMargin"
+            }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __bulkInstallApp;
+}
 function uninstallApp(payload) {
   function __uninstallApp({ host }) {
     const metadata = {
@@ -169,6 +229,9 @@ function uninstallApp(payload) {
       method: "POST",
       methodFqn: "wix.devcenter.apps.installer.v1.AppsInstallerService.UninstallApp",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixDevcenterAppsInstallerV1AppsInstallerServiceUrl({
         protoPath: "/v1/app-instance/uninstall",
         data: payload,
@@ -187,6 +250,9 @@ function bulkUninstallApp(payload) {
       method: "POST",
       methodFqn: "wix.devcenter.apps.installer.v1.AppsInstallerService.BulkUninstallApp",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixDevcenterAppsInstallerV1AppsInstallerServiceUrl({
         protoPath: "/v1/bulk/app-instance/uninstall",
         data: payload,
@@ -225,6 +291,9 @@ function installAppFromShareUrl(payload) {
       method: "POST",
       methodFqn: "wix.devcenter.apps.installer.v1.AppsInstallerService.InstallAppFromShareUrl",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixDevcenterAppsInstallerV1AppsInstallerServiceUrl({
         protoPath: "/v1/app-share-url/install",
         data: payload,
@@ -263,6 +332,9 @@ function isPermittedToInstallApps(payload) {
       method: "POST",
       methodFqn: "wix.devcenter.apps.installer.v1.AppsInstallerService.IsPermittedToInstallApps",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixDevcenterAppsInstallerV1AppsInstallerServiceUrl({
         protoPath: "/v1/app-instance/is-permitted-to-install",
         data: serializedData,
@@ -281,6 +353,9 @@ function getInstalledApps(payload) {
       method: "GET",
       methodFqn: "wix.devcenter.apps.installer.v1.AppsInstallerService.GetInstalledApps",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixDevcenterAppsInstallerV1AppsInstallerServiceUrl({
         protoPath: "/v1/app-instances",
         data: payload,
@@ -374,6 +449,35 @@ async function installApp2(tenant, options) {
     throw transformedError;
   }
 }
+async function bulkInstallApp2(tenant, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    tenant,
+    appInstances: options?.appInstances
+  });
+  const reqOpts = bulkInstallApp(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          tenant: "$[0]",
+          appInstances: "$[1].appInstances"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["tenant", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 async function uninstallApp2(options) {
   const { httpClient, sideEffects } = arguments[1];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
@@ -526,6 +630,14 @@ function installApp3(httpClient) {
     { httpClient }
   );
 }
+function bulkInstallApp3(httpClient) {
+  return (tenant, options) => bulkInstallApp2(
+    tenant,
+    options,
+    // @ts-ignore
+    { httpClient }
+  );
+}
 function uninstallApp3(httpClient) {
   return (options) => uninstallApp2(
     options,
@@ -583,6 +695,7 @@ var onAppInstanceAppInstalledOnTenant = (0, import_sdk_types.EventDefinition)(
 var import_rest_modules3 = require("@wix/sdk-runtime/rest-modules");
 var import_event_definition_modules = require("@wix/sdk-runtime/event-definition-modules");
 var installApp4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(installApp3);
+var bulkInstallApp4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(bulkInstallApp3);
 var uninstallApp4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(uninstallApp3);
 var bulkUninstallApp4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(bulkUninstallApp3);
 var installAppFromShareUrl4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(installAppFromShareUrl3);
@@ -598,6 +711,7 @@ var onAppInstanceAppInstalledOnTenant2 = (0, import_event_definition_modules.cre
   Status,
   TenantType,
   WebhookIdentityType,
+  bulkInstallApp,
   bulkUninstallApp,
   getInstalledApps,
   installApp,