@wix/bex-utils 1.28.0

package/@wix/ambassador-app-settings-v1-settings/build/es/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/es/types.impl.js

@@ -0,0 +1,25 @@
+/** The state of the settings (Saved or Published) */
+export var State;
+(function (State) {
+    /** Not relevant */
+    State["NR"] = "NR";
+    State["SAVED"] = "SAVED";
+    State["PUBLISHED"] = "PUBLISHED";
+})(State || (State = {}));
+/** The host in which the settings are displayed */
+export var Host;
+(function (Host) {
+    Host["NA"] = "NA";
+    Host["VIEWER"] = "VIEWER";
+    Host["BUSINESS_MANAGER"] = "BUSINESS_MANAGER";
+    Host["ONE_APP"] = "ONE_APP";
+})(Host || (Host = {}));
+/** scope of settings when creating/updating; */
+export 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 || (Scope = {}));
+//# sourceMappingURL=types.impl.js.map

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

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

package/@wix/ambassador-app-settings-v1-settings/builders/package.json

@@ -0,0 +1,7 @@
+{
+  "private": true,
+  "main": "../build/cjs/builders.impl",
+  "types": "../build/cjs/builders.impl.d.ts",
+  "sideEffects": false,
+  "module": "../build/es/builders.impl"
+}

package/@wix/ambassador-app-settings-v1-settings/http/package.json

@@ -0,0 +1,7 @@
+{
+  "private": true,
+  "main": "../build/cjs/http.impl",
+  "types": "../build/cjs/http.impl.d.ts",
+  "sideEffects": false,
+  "module": "../build/es/http.impl"
+}

package/@wix/ambassador-app-settings-v1-settings/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@wix/ambassador-app-settings-v1-settings",
+  "version": "1.0.46",
+  "publishConfig": {
+    "registry": "https://npm.dev.wixpress.com/",
+    "access": "restricted"
+  },
+  "files": [
+    "build",
+    "http",
+    "rpc",
+    "builders",
+    "types",
+    "crud/!(*.ts)",
+    "src/main/proto"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "yarn proto && yarn tsc && cp -r proto build/cjs",
+    "proto": "wix-proto-codegen --module . --dir proto --stringEnums --tsClasses --stringLongs",
+    "tsc": "tsc -b tsconfig.json tsconfig.esm.json",
+    "test": ":"
+  },
+  "dependencies": {
+    "@wix/metro-common-builders": "^1.0.0",
+    "@wix/metro-runtime": "^1.0.0",
+    "callsite": "^1.0.0"
+  },
+  "devDependencies": {
+    "@wix/http-client": "^1.0.0",
+    "@types/callsite": "^1.0.0"
+  },
+  "wix": {
+    "artifact": {
+      "artifactId": "app-settings-v1-settings",
+      "groupId": "com.wixpress.metro-packages"
+    },
+    "ambassador": {
+      "fqdn": "wix.app_settings.v1.settings",
+      "protoArtifactId": "com.wixpress.proto:app-settings-api"
+    }
+  },
+  "falconPackageHash": "bfe5bb548384cc21a93718bd9dba5cc1cdef5c57b439a46f597ffc43",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wix-private/metro-packages.git",
+    "directory": "packages/ambassador/app-settings-v1-settings"
+  }
+}

package/@wix/ambassador-app-settings-v1-settings/rpc/package.json

@@ -0,0 +1,6 @@
+{
+  "private": true,
+  "main": "../build/cjs/rpc.impl",
+  "types": "../build/cjs/rpc.impl.d.ts",
+  "sideEffects": false
+}