@wix/bex-utils 1.28.0

package/@wix/ambassador-app-settings-v1-settings/build/cjs/proto/server/proto-generated.js

@@ -0,0 +1,2 @@
+const wrapper = require('../proto-generated');
+module.exports = {services: wrapper, requests: wrapper, responses: wrapper};

package/@wix/ambassador-app-settings-v1-settings/build/cjs/rpc.impl.d.ts

@@ -0,0 +1,36 @@
+import { GetComponentSettingsRequest, GetComponentSettingsResponse, GetGlobalSettingsRequest, GetGlobalSettingsResponse, GetRequest, GetResponse, SetComponentSettingsRequest, SetComponentSettingsResponse, SetGlobalSettingsRequest, SetGlobalSettingsResponse, SetRequest, SetResponse, UpdateRequest, UpdateResponse, BulkGetComponentSettingsRequest, BulkGetComponentSettingsResponse, GetGlobalSettingsForMigrationRequest, GetGlobalSettingsForMigrationResponse, SetComponentSettingsForMigrationRequest, SetComponentSettingsForMigrationResponse, SetGlobalSettingsForMigrationRequest, SetGlobalSettingsForMigrationResponse } from './types.impl';
+import * as wrapper from './proto/proto-generated';
+declare const AppSettingsService: typeof wrapper.com.wix.fed.settings.AppSettingsService;
+export declare type RequestOptions<T = any, U = any> = {
+    _?: T;
+    requestData: any;
+    serviceArtifactId: string;
+    serviceProtoClass: U;
+    methodName: string;
+};
+/** Set component settings by componentId */
+export declare function setComponentSettings(payload: SetComponentSettingsRequest): RequestOptions<SetComponentSettingsResponse, typeof AppSettingsService>;
+/** Set component settings by componentId */
+export declare function setComponentSettingsForMigration(payload: SetComponentSettingsForMigrationRequest): RequestOptions<SetComponentSettingsForMigrationResponse, typeof AppSettingsService>;
+/** Get component settings by componentId */
+export declare function getComponentSettings(payload: GetComponentSettingsRequest): RequestOptions<GetComponentSettingsResponse, typeof AppSettingsService>;
+/** Get component settings by componentId */
+export declare function bulkGetComponentSettings(payload: BulkGetComponentSettingsRequest): RequestOptions<BulkGetComponentSettingsResponse, typeof AppSettingsService>;
+/** Set global settings by instanceId (extracted from Authorization) */
+export declare function setGlobalSettings(payload: SetGlobalSettingsRequest): RequestOptions<SetGlobalSettingsResponse, typeof AppSettingsService>;
+/** Get global settings by instanceId (extracted from Authorization) */
+export declare function getGlobalSettings(payload: GetGlobalSettingsRequest): RequestOptions<GetGlobalSettingsResponse, typeof AppSettingsService>;
+/** Set global settings for migration */
+export declare function setGlobalSettingsForMigration(payload: SetGlobalSettingsForMigrationRequest): RequestOptions<SetGlobalSettingsForMigrationResponse, typeof AppSettingsService>;
+/** Get global settings for migration */
+export declare function getGlobalSettingsForMigration(payload: GetGlobalSettingsForMigrationRequest): RequestOptions<GetGlobalSettingsForMigrationResponse, typeof AppSettingsService>;
+/**
+ * retrieve settings for site. app and component-scoped settings ids can be provided.
+ * looks-up settings for one or both ids provided.
+ */
+export declare function get(payload: GetRequest): RequestOptions<GetResponse, typeof AppSettingsService>;
+/** store new snapshot of settings on server */
+export declare function set(payload: SetRequest): RequestOptions<SetResponse, typeof AppSettingsService>;
+/** create new snapshot of settings (patch) */
+export declare function update(payload: UpdateRequest): RequestOptions<UpdateResponse, typeof AppSettingsService>;
+export {};

package/@wix/ambassador-app-settings-v1-settings/build/cjs/rpc.impl.js

@@ -0,0 +1,182 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.update = exports.set = exports.get = exports.getGlobalSettingsForMigration = exports.setGlobalSettingsForMigration = exports.getGlobalSettings = exports.setGlobalSettings = exports.bulkGetComponentSettings = exports.getComponentSettings = exports.setComponentSettingsForMigration = exports.setComponentSettings = void 0;
+var wrapper = __importStar(require("./proto/proto-generated"));
+var AppSettingsService = wrapper.com.wix.fed.settings.AppSettingsService;
+/** Set component settings by componentId */
+function setComponentSettings(payload) {
+    var serviceArtifactId = 'com.wixpress.fed.app-settings-service';
+    var serviceProtoClass = AppSettingsService;
+    var methodName = 'setComponentSettings';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+exports.setComponentSettings = setComponentSettings;
+/** Set component settings by componentId */
+function setComponentSettingsForMigration(payload) {
+    var serviceArtifactId = 'com.wixpress.fed.app-settings-service';
+    var serviceProtoClass = AppSettingsService;
+    var methodName = 'setComponentSettingsForMigration';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+exports.setComponentSettingsForMigration = setComponentSettingsForMigration;
+/** Get component settings by componentId */
+function getComponentSettings(payload) {
+    var serviceArtifactId = 'com.wixpress.fed.app-settings-service';
+    var serviceProtoClass = AppSettingsService;
+    var methodName = 'getComponentSettings';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+exports.getComponentSettings = getComponentSettings;
+/** Get component settings by componentId */
+function bulkGetComponentSettings(payload) {
+    var serviceArtifactId = 'com.wixpress.fed.app-settings-service';
+    var serviceProtoClass = AppSettingsService;
+    var methodName = 'bulkGetComponentSettings';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+exports.bulkGetComponentSettings = bulkGetComponentSettings;
+/** Set global settings by instanceId (extracted from Authorization) */
+function setGlobalSettings(payload) {
+    var serviceArtifactId = 'com.wixpress.fed.app-settings-service';
+    var serviceProtoClass = AppSettingsService;
+    var methodName = 'setGlobalSettings';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+exports.setGlobalSettings = setGlobalSettings;
+/** Get global settings by instanceId (extracted from Authorization) */
+function getGlobalSettings(payload) {
+    var serviceArtifactId = 'com.wixpress.fed.app-settings-service';
+    var serviceProtoClass = AppSettingsService;
+    var methodName = 'getGlobalSettings';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+exports.getGlobalSettings = getGlobalSettings;
+/** Set global settings for migration */
+function setGlobalSettingsForMigration(payload) {
+    var serviceArtifactId = 'com.wixpress.fed.app-settings-service';
+    var serviceProtoClass = AppSettingsService;
+    var methodName = 'setGlobalSettingsForMigration';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+exports.setGlobalSettingsForMigration = setGlobalSettingsForMigration;
+/** Get global settings for migration */
+function getGlobalSettingsForMigration(payload) {
+    var serviceArtifactId = 'com.wixpress.fed.app-settings-service';
+    var serviceProtoClass = AppSettingsService;
+    var methodName = 'getGlobalSettingsForMigration';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+exports.getGlobalSettingsForMigration = getGlobalSettingsForMigration;
+/**
+ * retrieve settings for site. app and component-scoped settings ids can be provided.
+ * looks-up settings for one or both ids provided.
+ */
+function get(payload) {
+    var serviceArtifactId = 'com.wixpress.fed.app-settings-service';
+    var serviceProtoClass = AppSettingsService;
+    var methodName = 'get';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+exports.get = get;
+/** store new snapshot of settings on server */
+function set(payload) {
+    var serviceArtifactId = 'com.wixpress.fed.app-settings-service';
+    var serviceProtoClass = AppSettingsService;
+    var methodName = 'set';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+exports.set = set;
+/** create new snapshot of settings (patch) */
+function update(payload) {
+    var serviceArtifactId = 'com.wixpress.fed.app-settings-service';
+    var serviceProtoClass = AppSettingsService;
+    var methodName = 'update';
+    var requestData = payload;
+    return {
+        serviceProtoClass: serviceProtoClass,
+        serviceArtifactId: serviceArtifactId,
+        methodName: methodName,
+        requestData: requestData,
+    };
+}
+exports.update = update;
+//# sourceMappingURL=rpc.impl.js.map

package/@wix/ambassador-app-settings-v1-settings/build/cjs/rpc.impl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc.impl.js","sourceRoot":"","sources":["../../rpc.impl.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAwBA,+DAAmD;AAEnD,IAAM,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,kBAAkB,CAAC;AAU3E,4CAA4C;AAC5C,SAAgB,oBAAoB,CAClC,OAAoC;IAEpC,IAAM,iBAAiB,GAAW,uCAAuC,CAAC;IAC1E,IAAM,iBAAiB,GAA8B,kBAAkB,CAAC;IACxE,IAAM,UAAU,GAAW,sBAAsB,CAAC;IAClD,IAAM,WAAW,GAAgC,OAAO,CAAC;IACzD,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAbD,oDAaC;AAED,4CAA4C;AAC5C,SAAgB,gCAAgC,CAC9C,OAAgD;IAKhD,IAAM,iBAAiB,GAAW,uCAAuC,CAAC;IAC1E,IAAM,iBAAiB,GAA8B,kBAAkB,CAAC;IACxE,IAAM,UAAU,GAAW,kCAAkC,CAAC;IAC9D,IAAM,WAAW,GAA4C,OAAO,CAAC;IACrE,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAhBD,4EAgBC;AAED,4CAA4C;AAC5C,SAAgB,oBAAoB,CAClC,OAAoC;IAEpC,IAAM,iBAAiB,GAAW,uCAAuC,CAAC;IAC1E,IAAM,iBAAiB,GAA8B,kBAAkB,CAAC;IACxE,IAAM,UAAU,GAAW,sBAAsB,CAAC;IAClD,IAAM,WAAW,GAAgC,OAAO,CAAC;IACzD,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAbD,oDAaC;AAED,4CAA4C;AAC5C,SAAgB,wBAAwB,CACtC,OAAwC;IAExC,IAAM,iBAAiB,GAAW,uCAAuC,CAAC;IAC1E,IAAM,iBAAiB,GAA8B,kBAAkB,CAAC;IACxE,IAAM,UAAU,GAAW,0BAA0B,CAAC;IACtD,IAAM,WAAW,GAAoC,OAAO,CAAC;IAC7D,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAbD,4DAaC;AAED,uEAAuE;AACvE,SAAgB,iBAAiB,CAC/B,OAAiC;IAEjC,IAAM,iBAAiB,GAAW,uCAAuC,CAAC;IAC1E,IAAM,iBAAiB,GAA8B,kBAAkB,CAAC;IACxE,IAAM,UAAU,GAAW,mBAAmB,CAAC;IAC/C,IAAM,WAAW,GAA6B,OAAO,CAAC;IACtD,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAbD,8CAaC;AAED,uEAAuE;AACvE,SAAgB,iBAAiB,CAC/B,OAAiC;IAEjC,IAAM,iBAAiB,GAAW,uCAAuC,CAAC;IAC1E,IAAM,iBAAiB,GAA8B,kBAAkB,CAAC;IACxE,IAAM,UAAU,GAAW,mBAAmB,CAAC;IAC/C,IAAM,WAAW,GAA6B,OAAO,CAAC;IACtD,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAbD,8CAaC;AAED,wCAAwC;AACxC,SAAgB,6BAA6B,CAC3C,OAA6C;IAK7C,IAAM,iBAAiB,GAAW,uCAAuC,CAAC;IAC1E,IAAM,iBAAiB,GAA8B,kBAAkB,CAAC;IACxE,IAAM,UAAU,GAAW,+BAA+B,CAAC;IAC3D,IAAM,WAAW,GAAyC,OAAO,CAAC;IAClE,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAhBD,sEAgBC;AAED,wCAAwC;AACxC,SAAgB,6BAA6B,CAC3C,OAA6C;IAK7C,IAAM,iBAAiB,GAAW,uCAAuC,CAAC;IAC1E,IAAM,iBAAiB,GAA8B,kBAAkB,CAAC;IACxE,IAAM,UAAU,GAAW,+BAA+B,CAAC;IAC3D,IAAM,WAAW,GAAyC,OAAO,CAAC;IAClE,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAhBD,sEAgBC;AAED;;;GAGG;AACH,SAAgB,GAAG,CACjB,OAAmB;IAEnB,IAAM,iBAAiB,GAAW,uCAAuC,CAAC;IAC1E,IAAM,iBAAiB,GAA8B,kBAAkB,CAAC;IACxE,IAAM,UAAU,GAAW,KAAK,CAAC;IACjC,IAAM,WAAW,GAAe,OAAO,CAAC;IACxC,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAbD,kBAaC;AAED,+CAA+C;AAC/C,SAAgB,GAAG,CACjB,OAAmB;IAEnB,IAAM,iBAAiB,GAAW,uCAAuC,CAAC;IAC1E,IAAM,iBAAiB,GAA8B,kBAAkB,CAAC;IACxE,IAAM,UAAU,GAAW,KAAK,CAAC;IACjC,IAAM,WAAW,GAAe,OAAO,CAAC;IACxC,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAbD,kBAaC;AAED,8CAA8C;AAC9C,SAAgB,MAAM,CACpB,OAAsB;IAEtB,IAAM,iBAAiB,GAAW,uCAAuC,CAAC;IAC1E,IAAM,iBAAiB,GAA8B,kBAAkB,CAAC;IACxE,IAAM,UAAU,GAAW,QAAQ,CAAC;IACpC,IAAM,WAAW,GAAkB,OAAO,CAAC;IAC3C,OAAO;QACL,iBAAiB,mBAAA;QACjB,iBAAiB,mBAAA;QACjB,UAAU,YAAA;QACV,WAAW,aAAA;KACZ,CAAC;AACJ,CAAC;AAbD,wBAaC"}

package/@wix/ambassador-app-settings-v1-settings/build/cjs/types.impl.d.ts

@@ -0,0 +1,313 @@
+export interface AppSettings {
+    /** The state of the component */
+    state?: State;
+    /** Where this data is relevant */
+    host?: Host;
+    /** The app global settings */
+    settings?: Record<string, any> | null;
+    /** Translatable textual assets - not using a collection because this type only the get flow (which should return a single value) */
+    translations?: Record<string, string>;
+}
+/** The state of the settings (Saved or Published) */
+export declare enum State {
+    /** Not relevant */
+    NR = "NR",
+    SAVED = "SAVED",
+    PUBLISHED = "PUBLISHED"
+}
+/** The host in which the settings are displayed */
+export declare enum Host {
+    NA = "NA",
+    VIEWER = "VIEWER",
+    BUSINESS_MANAGER = "BUSINESS_MANAGER",
+    ONE_APP = "ONE_APP"
+}
+export interface SetComponentSettingsRequest {
+    /** The component Id */
+    componentId: string | null;
+    /** The data we'd like to store for this component */
+    settings?: Record<string, any> | null;
+    /** The state to set in. ** THIS IS A DEPRECATED FIELD, PLEASE USE THE "states" FIELD ** */
+    state?: State;
+    /** Where this data is relevant */
+    host?: Host;
+    /** Translatable textual assets (pass empty key as default) */
+    translations?: TranslatedLanguage[];
+    /** The states to set in */
+    states?: State[];
+}
+/** The translated language that contains the key and its translations */
+export interface TranslatedLanguage {
+    /** The key of the translations' language */
+    languageKey?: LanguageKey;
+    /** Key-value pair mapping of textual assets */
+    translations?: Record<string, string>;
+}
+/** The language key of the saved multilingual data */
+export interface LanguageKey {
+    /** e.g. en */
+    languageCode?: string;
+    /** e.g. us */
+    regionCode?: string;
+    /** default: '' */
+    scriptVariant?: string;
+}
+export interface SetComponentSettingsResponse {
+    /** Echo of the component settings */
+    settings?: Record<string, any> | null;
+    /** Where this data is relevant */
+    host?: Host;
+    /** Translatable textual assets (pass empty key as default) */
+    translations?: TranslatedLanguage[];
+    /** The states this was set in */
+    states?: State[];
+}
+export interface SetComponentSettingsForMigrationRequest {
+    /** The component Id */
+    componentId?: string | null;
+    /** The data we'd like to store for this component */
+    settings?: Record<string, any> | null;
+    /** The state to set in. ** THIS IS A DEPRECATED FIELD, PLEASE USE THE "states" FIELD ** */
+    state?: State;
+    /** Where this data is relevant */
+    host?: Host;
+    /** Translatable textual assets (pass empty key as default) */
+    translations?: TranslatedLanguage[];
+    /** The states to set in */
+    states?: State[];
+    /** The appDefId for migration */
+    appDefId: string;
+    /** The instanceId for migration (msid) */
+    instanceId: string;
+}
+export interface SetComponentSettingsForMigrationResponse {
+    /** Echo of the component settings */
+    settings?: Record<string, any> | null;
+    /** Where this data is relevant */
+    host?: Host;
+    /** Translatable textual assets (pass empty key as default) */
+    translations?: TranslatedLanguage[];
+    /** The states this was set in */
+    states?: State[];
+}
+export interface GetComponentSettingsRequest {
+    /** The component we want data for. Component ids can be from the site or oneApp */
+    componentId: string | null;
+    /** The state of the component */
+    state?: State;
+    /** Where this data is relevant */
+    host?: Host;
+    /** The language key of the translation (allow filtering translations explicitly) */
+    languageKey?: LanguageKey;
+    /** Whether it is critical to get Global Settings as well */
+    includeGlobalSettings?: boolean;
+}
+export interface GetComponentSettingsResponse {
+    /** Component settings for the requested component id */
+    settings?: Record<string, any> | null;
+    /** The data state of the response */
+    state?: State;
+    /** Where this data is relevant */
+    host?: Host;
+    /** based on x-wix-language or fallback */
+    translations?: Record<string, string>;
+    /** Optional. The global app settings */
+    globalSettings?: AppSettings;
+}
+export interface BulkGetComponentSettingsRequest {
+    /** The component we want data for. Component ids can be from the site or oneApp */
+    componentIds?: string[];
+    /** The state of the component */
+    state?: State;
+    /** Where this data is relevant */
+    host?: Host;
+    /** The language key of the translation (allow filtering translations explicitly) */
+    languageKey?: LanguageKey;
+}
+export interface BulkGetComponentSettingsResponse {
+    componentSettings?: ComponentSettings[];
+}
+export interface ComponentSettings {
+    componentId?: string;
+    /** Component settings for the requested component id */
+    settings?: Record<string, any> | null;
+    /** The data state of the response */
+    state?: State;
+    /** Where this data is relevant */
+    host?: Host;
+    /** based on x-wix-language or fallback */
+    translations?: Record<string, string>;
+}
+export interface SetGlobalSettingsRequest {
+    /** The global settings for the app */
+    settings?: Record<string, any> | null;
+    /** Any components we would like to set */
+    componentSettings?: SetComponentSettingsItem[];
+    /** The state this is set in. ** THIS IS A DEPRECATED FIELD, PLEASE USE THE "states" FIELD ** */
+    state?: State;
+    /** Where this data is relevant */
+    host?: Host;
+    /** Translatable textual assets (pass empty key as default) */
+    translations?: TranslatedLanguage[];
+    /** The states this was set in */
+    states?: State[];
+}
+export interface SetComponentSettingsItem {
+    /** The state of the component */
+    state?: State;
+    /** Where this data is relevant */
+    host?: Host;
+    /** The component we want data for. Component ids can be from the site or oneApp */
+    componentId?: string | null;
+    /** The component settings */
+    settings?: Record<string, any> | null;
+    /** Translatable textual assets (pass empty key as default) */
+    translations?: TranslatedLanguage[];
+}
+export interface SetGlobalSettingsResponse {
+    /** The data we have not for the App */
+    settings?: Record<string, any> | null;
+    /** The data we have for the components */
+    componentSettings?: SetComponentSettingsItem[];
+    /** Where this data is relevant */
+    host?: Host;
+    /** Translatable textual assets (pass empty key as default) */
+    translations?: TranslatedLanguage[];
+    /** The states this was set in */
+    states?: State[];
+}
+export interface GetGlobalSettingsRequest {
+    /** The requested state, default is published */
+    state?: State;
+    /** Allow to filter by host to get only components for that host */
+    host?: Host;
+    /** If component settings data should also be returned */
+    includeComponentSettings?: boolean;
+    /** The language key of the translation (allow filtering translations explicitly) */
+    languageKey?: LanguageKey;
+}
+export interface GetGlobalSettingsResponse {
+    /** The state of the app */
+    state?: State;
+    /** Where this data is relevant */
+    host?: Host;
+    /** The global app settings */
+    settings?: Record<string, any> | null;
+    /** Optional. All components listed. may include components from the site or oneApp */
+    componentSettings?: GetComponentSettingsItem[];
+    /** based on x-wix-language or fallback */
+    translations?: Record<string, string>;
+}
+export interface GetComponentSettingsItem {
+    /** The state of the component */
+    state?: State;
+    /** Where this data is relevant */
+    host?: Host;
+    /** The component we want data for. Component ids can be from the site or oneApp */
+    componentId?: string | null;
+    /** The component settings */
+    settings?: Record<string, any> | null;
+    /** Translatable textual assets - not using a collection because this type only the get flow (which should return a single value) */
+    translations?: Record<string, string>;
+}
+export interface SetGlobalSettingsForMigrationRequest {
+    /** The global settings for the app */
+    settings?: Record<string, any> | null;
+    /** Any components we would like to set */
+    componentSettings?: SetComponentSettingsItem[];
+    /** The state this is set in. ** THIS IS A DEPRECATED FIELD, PLEASE USE THE "states" FIELD ** */
+    state?: State;
+    /** Where this data is relevant */
+    host?: Host;
+    /** Translatable textual assets (pass empty key as default) */
+    translations?: TranslatedLanguage[];
+    /** The states this was set in */
+    states?: State[];
+    /** The appDefId for migration */
+    appDefId: string;
+    /** The instanceId for migration (msid) */
+    instanceId: string;
+}
+export interface SetGlobalSettingsForMigrationResponse {
+    /** The data we have not for the App */
+    settings?: Record<string, any> | null;
+    /** The data we have for the components */
+    componentSettings?: SetComponentSettingsItem[];
+    /** Where this data is relevant */
+    host?: Host;
+    /** Translatable textual assets (pass empty key as default) */
+    translations?: TranslatedLanguage[];
+    /** The states this was set in */
+    states?: State[];
+}
+export interface GetGlobalSettingsForMigrationRequest {
+    /** The requested state, default is published */
+    state?: State;
+    /** Allow to filter by host to get only components for that host */
+    host?: Host;
+    /** If component settings data should also be returned */
+    includeComponentSettings?: boolean;
+    /** The language key of the translation (allow filtering translations explicitly) */
+    languageKey?: LanguageKey;
+    /** The appDefId for migration */
+    appDefId: string;
+    /** The instanceId for migration (msid) */
+    instanceId: string;
+}
+export interface GetGlobalSettingsForMigrationResponse {
+    /** The state of the app */
+    state?: State;
+    /** Where this data is relevant */
+    host?: Host;
+    /** The global app settings */
+    settings?: Record<string, any> | null;
+    /** Optional. All components listed. may include components from the site or oneApp */
+    componentSettings?: GetComponentSettingsItem[];
+    /** based on x-wix-language or fallback */
+    translations?: Record<string, string>;
+}
+export interface GetRequest {
+    /** id of app-scoped settings */
+    externalAppId?: string | null;
+    /** id of component-scoped settings */
+    externalComponentId?: string | null;
+    /** desired fields to retrieve on either GetResponse.app_settings or GetResponse.component_settings */
+    fields?: string[];
+}
+export interface GetResponse {
+    /** app-scoped settings; */
+    appSettings?: Record<string, any> | null;
+    /** component-scoped settings; */
+    componentSettings?: Record<string, any> | null;
+}
+export interface SetRequest {
+    /** id of settings snapshot */
+    externalId: string | null;
+    /** scope of settings to store */
+    scope: Scope;
+    /** settings themselves; */
+    data: Record<string, any> | null;
+}
+/** scope of settings when creating/updating; */
+export declare enum Scope {
+    /** multiple instances of a tpa can share same settings; */
+    APP = "APP",
+    /** scoped to a single component of an app; */
+    COMPONENT = "COMPONENT"
+}
+export interface SetResponse {
+}
+export interface UpdateRequest {
+    /** id of settings snapshot */
+    externalId: string | null;
+    /** scope of settings to update */
+    scope: Scope;
+    /** changed fields in provided data */
+    fields: string[];
+    /** data itself */
+    data: Record<string, any> | null;
+}
+export interface UpdateResponse {
+    /** new if of stored settings snapshot */
+    newExternalId?: string | null;
+}

package/@wix/ambassador-app-settings-v1-settings/build/cjs/types.impl.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Scope = exports.Host = exports.State = void 0;
+/** The state of the settings (Saved or Published) */
+var State;
+(function (State) {
+    /** Not relevant */
+    State["NR"] = "NR";
+    State["SAVED"] = "SAVED";
+    State["PUBLISHED"] = "PUBLISHED";
+})(State = exports.State || (exports.State = {}));
+/** The host in which the settings are displayed */
+var Host;
+(function (Host) {
+    Host["NA"] = "NA";
+    Host["VIEWER"] = "VIEWER";
+    Host["BUSINESS_MANAGER"] = "BUSINESS_MANAGER";
+    Host["ONE_APP"] = "ONE_APP";
+})(Host = exports.Host || (exports.Host = {}));
+/** scope of settings when creating/updating; */
+var Scope;
+(function (Scope) {
+    /** multiple instances of a tpa can share same settings; */
+    Scope["APP"] = "APP";
+    /** scoped to a single component of an app; */
+    Scope["COMPONENT"] = "COMPONENT";
+})(Scope = exports.Scope || (exports.Scope = {}));
+//# sourceMappingURL=types.impl.js.map

package/@wix/ambassador-app-settings-v1-settings/build/cjs/types.impl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.impl.js","sourceRoot":"","sources":["../../types.impl.ts"],"names":[],"mappings":";;;AAWA,qDAAqD;AACrD,IAAY,KAKX;AALD,WAAY,KAAK;IACf,mBAAmB;IACnB,kBAAS,CAAA;IACT,wBAAe,CAAA;IACf,gCAAuB,CAAA;AACzB,CAAC,EALW,KAAK,GAAL,aAAK,KAAL,aAAK,QAKhB;AAED,mDAAmD;AACnD,IAAY,IAKX;AALD,WAAY,IAAI;IACd,iBAAS,CAAA;IACT,yBAAiB,CAAA;IACjB,6CAAqC,CAAA;IACrC,2BAAmB,CAAA;AACrB,CAAC,EALW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAKf;AAoSD,gDAAgD;AAChD,IAAY,KAKX;AALD,WAAY,KAAK;IACf,2DAA2D;IAC3D,oBAAW,CAAA;IACX,8CAA8C;IAC9C,gCAAuB,CAAA;AACzB,CAAC,EALW,KAAK,GAAL,aAAK,KAAL,aAAK,QAKhB"}

package/@wix/ambassador-app-settings-v1-settings/build/es/builders.impl.d.ts

@@ -0,0 +1,33 @@
+import { AppSettings, GetComponentSettingsItem, GetComponentSettingsRequest, GetComponentSettingsResponse, GetGlobalSettingsRequest, GetGlobalSettingsResponse, GetRequest, GetResponse, Host, LanguageKey, Scope, SetComponentSettingsItem, SetComponentSettingsRequest, SetComponentSettingsResponse, SetGlobalSettingsRequest, SetGlobalSettingsResponse, SetRequest, SetResponse, State, TranslatedLanguage, UpdateRequest, UpdateResponse, BulkGetComponentSettingsRequest, BulkGetComponentSettingsResponse, ComponentSettings, GetGlobalSettingsForMigrationRequest, GetGlobalSettingsForMigrationResponse, SetComponentSettingsForMigrationRequest, SetComponentSettingsForMigrationResponse, SetGlobalSettingsForMigrationRequest, SetGlobalSettingsForMigrationResponse } from './types.impl';
+export declare function aAppSettings(overrideObject?: Partial<AppSettings>): AppSettings;
+export declare function aState(enumFirstItem?: State): State;
+export declare function aHost(enumFirstItem?: Host): Host;
+export declare function aSetComponentSettingsRequest(overrideObject?: Partial<SetComponentSettingsRequest>): SetComponentSettingsRequest;
+export declare function aTranslatedLanguage(overrideObject?: Partial<TranslatedLanguage>): TranslatedLanguage;
+export declare function aLanguageKey(overrideObject?: Partial<LanguageKey>): LanguageKey;
+export declare function aSetComponentSettingsResponse(overrideObject?: Partial<SetComponentSettingsResponse>): SetComponentSettingsResponse;
+export declare function aSetComponentSettingsForMigrationRequest(overrideObject?: Partial<SetComponentSettingsForMigrationRequest>): SetComponentSettingsForMigrationRequest;
+export declare function aSetComponentSettingsForMigrationResponse(overrideObject?: Partial<SetComponentSettingsForMigrationResponse>): SetComponentSettingsForMigrationResponse;
+export declare function aGetComponentSettingsRequest(overrideObject?: Partial<GetComponentSettingsRequest>): GetComponentSettingsRequest;
+export declare function aGetComponentSettingsResponse(overrideObject?: Partial<GetComponentSettingsResponse>): GetComponentSettingsResponse;
+export declare function aBulkGetComponentSettingsRequest(overrideObject?: Partial<BulkGetComponentSettingsRequest>): BulkGetComponentSettingsRequest;
+export declare function aBulkGetComponentSettingsResponse(overrideObject?: Partial<BulkGetComponentSettingsResponse>): BulkGetComponentSettingsResponse;
+export declare function aComponentSettings(overrideObject?: Partial<ComponentSettings>): ComponentSettings;
+export declare function aSetGlobalSettingsRequest(overrideObject?: Partial<SetGlobalSettingsRequest>): SetGlobalSettingsRequest;
+export declare function aSetComponentSettingsItem(overrideObject?: Partial<SetComponentSettingsItem>): SetComponentSettingsItem;
+export declare function aSetGlobalSettingsResponse(overrideObject?: Partial<SetGlobalSettingsResponse>): SetGlobalSettingsResponse;
+export declare function aGetGlobalSettingsRequest(overrideObject?: Partial<GetGlobalSettingsRequest>): GetGlobalSettingsRequest;
+export declare function aGetGlobalSettingsResponse(overrideObject?: Partial<GetGlobalSettingsResponse>): GetGlobalSettingsResponse;
+export declare function aGetComponentSettingsItem(overrideObject?: Partial<GetComponentSettingsItem>): GetComponentSettingsItem;
+export declare function aSetGlobalSettingsForMigrationRequest(overrideObject?: Partial<SetGlobalSettingsForMigrationRequest>): SetGlobalSettingsForMigrationRequest;
+export declare function aSetGlobalSettingsForMigrationResponse(overrideObject?: Partial<SetGlobalSettingsForMigrationResponse>): SetGlobalSettingsForMigrationResponse;
+export declare function aGetGlobalSettingsForMigrationRequest(overrideObject?: Partial<GetGlobalSettingsForMigrationRequest>): GetGlobalSettingsForMigrationRequest;
+export declare function aGetGlobalSettingsForMigrationResponse(overrideObject?: Partial<GetGlobalSettingsForMigrationResponse>): GetGlobalSettingsForMigrationResponse;
+export declare function aGetRequest(overrideObject?: Partial<GetRequest>): GetRequest;
+export declare function aGetResponse(overrideObject?: Partial<GetResponse>): GetResponse;
+export declare function aSetRequest(overrideObject?: Partial<SetRequest>): SetRequest;
+export declare function aScope(enumFirstItem?: Scope): Scope;
+export declare function aSetResponse(overrideObject?: Partial<SetResponse>): SetResponse;
+export declare function aUpdateRequest(overrideObject?: Partial<UpdateRequest>): UpdateRequest;
+export declare function aUpdateResponse(overrideObject?: Partial<UpdateResponse>): UpdateResponse;
+export * from '@wix/metro-common-builders';