@wix/sdk 1.4.0 → 1.5.0

package/build/browser/index.mjs

@@ -107,6 +107,7 @@ function objectToKeyValue(input) {
 }
 
 // src/rest-modules.ts
+var getDefaultDomain = (method, url) => method === "GET" && !FORCE_WRITE_API_URLS.some((write_url) => url === write_url) ? READ_ONLY_API_URL : API_URL;
 function buildRESTDescriptor(origFunc, publicMetadata, boundFetch, options) {
   return origFunc({
     request: async (factory) => {
@@ -116,8 +117,7 @@ function buildRESTDescriptor(origFunc, publicMetadata, boundFetch, options) {
       if (request.method === "GET" && ((_a = request.fallback) == null ? void 0 : _a.length) && request.params.toString().length > 4e3) {
         request = requestOptions.fallback[0];
       }
-      const getDefaultDomain = () => request.method === "GET" && !FORCE_WRITE_API_URLS.some((url2) => request.url === url2) ? READ_ONLY_API_URL : API_URL;
-      const domain = (_b = options == null ? void 0 : options.HTTPHost) != null ? _b : getDefaultDomain();
+      const domain = (_b = options == null ? void 0 : options.HTTPHost) != null ? _b : getDefaultDomain(request.method, request.url);
       let url = `https://${domain}${request.url}`;
       if (request.params && request.params.toString()) {
         url += `?${request.params.toString()}`;
@@ -186,6 +186,42 @@ var errorBuilder = (code, description, details, data) => {
   };
 };
 
+// src/fetch-error.ts
+var FetchErrorResponse = class extends Error {
+  constructor(message, response) {
+    super(message);
+    this.message = message;
+    this.response = response;
+  }
+  async details() {
+    const dataError = await this.response.json();
+    return errorBuilder2(
+      this.response.status,
+      dataError == null ? void 0 : dataError.message,
+      dataError == null ? void 0 : dataError.details,
+      {
+        requestId: this.response.headers.get("X-Wix-Request-Id"),
+        details: dataError
+      }
+    );
+  }
+};
+var errorBuilder2 = (code, description, details, data) => {
+  return {
+    details: {
+      ...!(details == null ? void 0 : details.validationError) && {
+        applicationError: {
+          description,
+          code,
+          data
+        }
+      },
+      ...details
+    },
+    message: description
+  };
+};
+
 // src/wixClient.ts
 function createClient(config) {
   const _headers = config.headers || { Authorization: "" };
@@ -247,6 +283,23 @@ function createClient(config) {
       finalUrl.host = API_URL;
       finalUrl.protocol = "https";
       return boundFetch(finalUrl, options);
+    },
+    async graphql(query, variables) {
+      const res = await boundFetch(`https://${API_URL}/graphql`, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify({ query, variables })
+      });
+      if (res.status !== 200) {
+        throw new FetchErrorResponse(
+          `GraphQL request failed with status ${res.status}`,
+          res
+        );
+      }
+      const { data, errors } = await res.json();
+      return { data: data != null ? data : {}, errors };
     }
   };
 }
@@ -913,5 +966,6 @@ export {
   WixAppOAuthStrategy,
   createClient,
   decodeText,
+  getDefaultDomain,
   media
 };

package/build/index.d.mts

@@ -9,6 +9,8 @@ type PublicMetadata = {
 };
 declare const API_URL = "www.wixapis.com";
 
+declare const getDefaultDomain: (method: string, url: string) => "www.wixapis.com" | "readonly.wixapis.com";
+
 type RequestContext = {
     isSSR: boolean;
     host: string;
@@ -36,6 +38,45 @@ type AmbassadorFactory<Request, Response> = {
 type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
 type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
 
+/**
+ * Represents a location in a Source.
+ */
+interface SourceLocation {
+  readonly line: number;
+  readonly column: number;
+}
+
+/**
+ * See: https://spec.graphql.org/draft/#sec-Errors
+ */
+interface GraphQLFormattedError {
+  /**
+   * A short, human-readable summary of the problem that **SHOULD NOT** change
+   * from occurrence to occurrence of the problem, except for purposes of
+   * localization.
+   */
+  readonly message: string;
+  /**
+   * If an error can be associated to a particular point in the requested
+   * GraphQL document, it should contain a list of locations.
+   */
+  readonly locations?: ReadonlyArray<SourceLocation>;
+  /**
+   * If an error can be associated to a particular field in the GraphQL result,
+   * it _must_ contain an entry with the key `path` that details the path of
+   * the response field which experienced the error. This allows clients to
+   * identify whether a null result is intentional or caused by a runtime error.
+   */
+  readonly path?: ReadonlyArray<string | number>;
+  /**
+   * Reserved for implementors to extend the protocol however they see fit,
+   * and hence there are no additional restrictions on its contents.
+   */
+  readonly extensions?: {
+    [key: string]: unknown;
+  };
+}
+
 type Headers = {
     Authorization: string;
 } & Record<string, string>;
@@ -70,11 +111,31 @@ type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostM
 type AssertHostMatches<T extends Descriptors, H extends Host<any>> = T extends HostModule<any, infer U> ? H extends undefined ? never : H extends U ? T : HostModule<any, H> : T extends RESTFunctionDescriptor<any> ? T : {
     [Key in keyof T]: T[Key] extends Descriptors ? AssertHostMatches<T[Key], H> : T[Key];
 };
+type TypedQueryInput<Result = {
+    [key: string]: any;
+}, Variables = {
+    [key: string]: any;
+}> = {
+    /**
+     * Type to support `@graphql-typed-document-node/core`
+     * @internal
+     */
+    __apiType?: (variables: Variables) => Result;
+    /**
+     * Type to support `TypedQueryDocumentNode` from `graphql`
+     * @internal
+     */
+    __ensureTypesOfVariablesAndResultMatching?: (variables: Variables) => Result;
+};
 type WixClient<H extends Host<any> | undefined = undefined, Z extends AuthenticationStrategy<H> = AuthenticationStrategy<H>, T extends Descriptors = Descriptors> = {
     setHeaders(headers: Headers): void;
     auth: Z;
     fetch(relativeUrl: string, options: RequestInit): Promise<Response>;
     use<R extends Descriptors = EmptyObject>(modules: H extends Host<any> ? AssertHostMatches<R, H> : R): BuildDescriptors<R, H>;
+    graphql<Result, Variables>(query: string | (string & TypedQueryInput<Result, Variables>), variables?: Variables): Promise<{
+        data: Result;
+        errors?: GraphQLFormattedError[];
+    }>;
 } & BuildDescriptors<T, H>;
 declare function createClient<H extends Host<any> | undefined = undefined, Z extends AuthenticationStrategy<H> = AuthenticationStrategy<H>, T extends Descriptors = EmptyObject>(config: {
     modules?: H extends Host<any> ? AssertHostMatches<T, H> : T;
@@ -307,4 +368,4 @@ declare function WixAppOAuthStrategy(opts: {
     refreshToken?: string;
 }): WixAppOAuthStrategy;
 
-export { API_URL, AccessToken, ApiKeyStrategy, AssertHostMatches, BuildDescriptors, CalculateNextState, Descriptors, IApiKeyStrategy, IOAuthStrategy, LoginParams, LoginState, OAuthStrategy, OauthData, OauthPKCE, ProcessableState, RefreshToken, RegisterParams, StateMachine, Token, TokenResponse, TokenRole, Tokens, WixAppOAuthStrategy, WixClient, createClient, decodeText, media };
+export { API_URL, AccessToken, ApiKeyStrategy, AssertHostMatches, BuildDescriptors, CalculateNextState, Descriptors, IApiKeyStrategy, IOAuthStrategy, LoginParams, LoginState, OAuthStrategy, OauthData, OauthPKCE, ProcessableState, RefreshToken, RegisterParams, StateMachine, Token, TokenResponse, TokenRole, Tokens, WixAppOAuthStrategy, WixClient, createClient, decodeText, getDefaultDomain, media };

package/build/index.d.ts

@@ -9,6 +9,8 @@ type PublicMetadata = {
 };
 declare const API_URL = "www.wixapis.com";
 
+declare const getDefaultDomain: (method: string, url: string) => "www.wixapis.com" | "readonly.wixapis.com";
+
 type RequestContext = {
     isSSR: boolean;
     host: string;
@@ -36,6 +38,45 @@ type AmbassadorFactory<Request, Response> = {
 type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
 type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
 
+/**
+ * Represents a location in a Source.
+ */
+interface SourceLocation {
+  readonly line: number;
+  readonly column: number;
+}
+
+/**
+ * See: https://spec.graphql.org/draft/#sec-Errors
+ */
+interface GraphQLFormattedError {
+  /**
+   * A short, human-readable summary of the problem that **SHOULD NOT** change
+   * from occurrence to occurrence of the problem, except for purposes of
+   * localization.
+   */
+  readonly message: string;
+  /**
+   * If an error can be associated to a particular point in the requested
+   * GraphQL document, it should contain a list of locations.
+   */
+  readonly locations?: ReadonlyArray<SourceLocation>;
+  /**
+   * If an error can be associated to a particular field in the GraphQL result,
+   * it _must_ contain an entry with the key `path` that details the path of
+   * the response field which experienced the error. This allows clients to
+   * identify whether a null result is intentional or caused by a runtime error.
+   */
+  readonly path?: ReadonlyArray<string | number>;
+  /**
+   * Reserved for implementors to extend the protocol however they see fit,
+   * and hence there are no additional restrictions on its contents.
+   */
+  readonly extensions?: {
+    [key: string]: unknown;
+  };
+}
+
 type Headers = {
     Authorization: string;
 } & Record<string, string>;
@@ -70,11 +111,31 @@ type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostM
 type AssertHostMatches<T extends Descriptors, H extends Host<any>> = T extends HostModule<any, infer U> ? H extends undefined ? never : H extends U ? T : HostModule<any, H> : T extends RESTFunctionDescriptor<any> ? T : {
     [Key in keyof T]: T[Key] extends Descriptors ? AssertHostMatches<T[Key], H> : T[Key];
 };
+type TypedQueryInput<Result = {
+    [key: string]: any;
+}, Variables = {
+    [key: string]: any;
+}> = {
+    /**
+     * Type to support `@graphql-typed-document-node/core`
+     * @internal
+     */
+    __apiType?: (variables: Variables) => Result;
+    /**
+     * Type to support `TypedQueryDocumentNode` from `graphql`
+     * @internal
+     */
+    __ensureTypesOfVariablesAndResultMatching?: (variables: Variables) => Result;
+};
 type WixClient<H extends Host<any> | undefined = undefined, Z extends AuthenticationStrategy<H> = AuthenticationStrategy<H>, T extends Descriptors = Descriptors> = {
     setHeaders(headers: Headers): void;
     auth: Z;
     fetch(relativeUrl: string, options: RequestInit): Promise<Response>;
     use<R extends Descriptors = EmptyObject>(modules: H extends Host<any> ? AssertHostMatches<R, H> : R): BuildDescriptors<R, H>;
+    graphql<Result, Variables>(query: string | (string & TypedQueryInput<Result, Variables>), variables?: Variables): Promise<{
+        data: Result;
+        errors?: GraphQLFormattedError[];
+    }>;
 } & BuildDescriptors<T, H>;
 declare function createClient<H extends Host<any> | undefined = undefined, Z extends AuthenticationStrategy<H> = AuthenticationStrategy<H>, T extends Descriptors = EmptyObject>(config: {
     modules?: H extends Host<any> ? AssertHostMatches<T, H> : T;
@@ -307,4 +368,4 @@ declare function WixAppOAuthStrategy(opts: {
     refreshToken?: string;
 }): WixAppOAuthStrategy;
 
-export { API_URL, AccessToken, ApiKeyStrategy, AssertHostMatches, BuildDescriptors, CalculateNextState, Descriptors, IApiKeyStrategy, IOAuthStrategy, LoginParams, LoginState, OAuthStrategy, OauthData, OauthPKCE, ProcessableState, RefreshToken, RegisterParams, StateMachine, Token, TokenResponse, TokenRole, Tokens, WixAppOAuthStrategy, WixClient, createClient, decodeText, media };
+export { API_URL, AccessToken, ApiKeyStrategy, AssertHostMatches, BuildDescriptors, CalculateNextState, Descriptors, IApiKeyStrategy, IOAuthStrategy, LoginParams, LoginState, OAuthStrategy, OauthData, OauthPKCE, ProcessableState, RefreshToken, RegisterParams, StateMachine, Token, TokenResponse, TokenRole, Tokens, WixAppOAuthStrategy, WixClient, createClient, decodeText, getDefaultDomain, media };

package/build/index.js

@@ -39,6 +39,7 @@ __export(src_exports, {
   WixAppOAuthStrategy: () => WixAppOAuthStrategy,
   createClient: () => createClient,
   decodeText: () => decodeText,
+  getDefaultDomain: () => getDefaultDomain,
   media: () => media
 });
 module.exports = __toCommonJS(src_exports);
@@ -151,6 +152,7 @@ function objectToKeyValue(input) {
 }
 
 // src/rest-modules.ts
+var getDefaultDomain = (method, url) => method === "GET" && !FORCE_WRITE_API_URLS.some((write_url) => url === write_url) ? READ_ONLY_API_URL : API_URL;
 function buildRESTDescriptor(origFunc, publicMetadata, boundFetch, options) {
   return origFunc({
     request: async (factory) => {
@@ -159,8 +161,7 @@ function buildRESTDescriptor(origFunc, publicMetadata, boundFetch, options) {
       if (request.method === "GET" && request.fallback?.length && request.params.toString().length > 4e3) {
         request = requestOptions.fallback[0];
       }
-      const getDefaultDomain = () => request.method === "GET" && !FORCE_WRITE_API_URLS.some((url2) => request.url === url2) ? READ_ONLY_API_URL : API_URL;
-      const domain = options?.HTTPHost ?? getDefaultDomain();
+      const domain = options?.HTTPHost ?? getDefaultDomain(request.method, request.url);
       let url = `https://${domain}${request.url}`;
       if (request.params && request.params.toString()) {
         url += `?${request.params.toString()}`;
@@ -229,6 +230,42 @@ var errorBuilder = (code, description, details, data) => {
   };
 };
 
+// src/fetch-error.ts
+var FetchErrorResponse = class extends Error {
+  constructor(message, response) {
+    super(message);
+    this.message = message;
+    this.response = response;
+  }
+  async details() {
+    const dataError = await this.response.json();
+    return errorBuilder2(
+      this.response.status,
+      dataError?.message,
+      dataError?.details,
+      {
+        requestId: this.response.headers.get("X-Wix-Request-Id"),
+        details: dataError
+      }
+    );
+  }
+};
+var errorBuilder2 = (code, description, details, data) => {
+  return {
+    details: {
+      ...!details?.validationError && {
+        applicationError: {
+          description,
+          code,
+          data
+        }
+      },
+      ...details
+    },
+    message: description
+  };
+};
+
 // src/wixClient.ts
 function createClient(config) {
   const _headers = config.headers || { Authorization: "" };
@@ -290,6 +327,23 @@ function createClient(config) {
       finalUrl.host = API_URL;
       finalUrl.protocol = "https";
       return boundFetch(finalUrl, options);
+    },
+    async graphql(query, variables) {
+      const res = await boundFetch(`https://${API_URL}/graphql`, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify({ query, variables })
+      });
+      if (res.status !== 200) {
+        throw new FetchErrorResponse(
+          `GraphQL request failed with status ${res.status}`,
+          res
+        );
+      }
+      const { data, errors } = await res.json();
+      return { data: data ?? {}, errors };
     }
   };
 }
@@ -950,6 +1004,7 @@ __reExport(src_exports, require("@wix/sdk-types"), module.exports);
   WixAppOAuthStrategy,
   createClient,
   decodeText,
+  getDefaultDomain,
   media,
   ...require("@wix/sdk-types")
 });

package/build/index.mjs

@@ -106,6 +106,7 @@ function objectToKeyValue(input) {
 }
 
 // src/rest-modules.ts
+var getDefaultDomain = (method, url) => method === "GET" && !FORCE_WRITE_API_URLS.some((write_url) => url === write_url) ? READ_ONLY_API_URL : API_URL;
 function buildRESTDescriptor(origFunc, publicMetadata, boundFetch, options) {
   return origFunc({
     request: async (factory) => {
@@ -114,8 +115,7 @@ function buildRESTDescriptor(origFunc, publicMetadata, boundFetch, options) {
       if (request.method === "GET" && request.fallback?.length && request.params.toString().length > 4e3) {
         request = requestOptions.fallback[0];
       }
-      const getDefaultDomain = () => request.method === "GET" && !FORCE_WRITE_API_URLS.some((url2) => request.url === url2) ? READ_ONLY_API_URL : API_URL;
-      const domain = options?.HTTPHost ?? getDefaultDomain();
+      const domain = options?.HTTPHost ?? getDefaultDomain(request.method, request.url);
       let url = `https://${domain}${request.url}`;
       if (request.params && request.params.toString()) {
         url += `?${request.params.toString()}`;
@@ -184,6 +184,42 @@ var errorBuilder = (code, description, details, data) => {
   };
 };
 
+// src/fetch-error.ts
+var FetchErrorResponse = class extends Error {
+  constructor(message, response) {
+    super(message);
+    this.message = message;
+    this.response = response;
+  }
+  async details() {
+    const dataError = await this.response.json();
+    return errorBuilder2(
+      this.response.status,
+      dataError?.message,
+      dataError?.details,
+      {
+        requestId: this.response.headers.get("X-Wix-Request-Id"),
+        details: dataError
+      }
+    );
+  }
+};
+var errorBuilder2 = (code, description, details, data) => {
+  return {
+    details: {
+      ...!details?.validationError && {
+        applicationError: {
+          description,
+          code,
+          data
+        }
+      },
+      ...details
+    },
+    message: description
+  };
+};
+
 // src/wixClient.ts
 function createClient(config) {
   const _headers = config.headers || { Authorization: "" };
@@ -245,6 +281,23 @@ function createClient(config) {
       finalUrl.host = API_URL;
       finalUrl.protocol = "https";
       return boundFetch(finalUrl, options);
+    },
+    async graphql(query, variables) {
+      const res = await boundFetch(`https://${API_URL}/graphql`, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify({ query, variables })
+      });
+      if (res.status !== 200) {
+        throw new FetchErrorResponse(
+          `GraphQL request failed with status ${res.status}`,
+          res
+        );
+      }
+      const { data, errors } = await res.json();
+      return { data: data ?? {}, errors };
     }
   };
 }
@@ -904,5 +957,6 @@ export {
   WixAppOAuthStrategy,
   createClient,
   decodeText,
+  getDefaultDomain,
   media
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/sdk",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "license": "UNLICENSED",
   "author": {
     "name": "Ronny Ringel",
@@ -31,26 +31,30 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.22.15",
-    "@wix/identity": "^1.0.56",
+    "@wix/identity": "^1.0.57",
     "@wix/image-kit": "^1.37.0",
-    "@wix/metro-runtime": "^1.1528.0",
+    "@wix/metro-runtime": "^1.1529.0",
     "@wix/redirects": "^1.0.24",
-    "@wix/sdk-types": "1.4.0",
+    "@wix/sdk-types": "1.5.0",
     "pkce-challenge": "^3.1.0",
     "querystring": "^0.2.1",
     "type-fest": "^3.13.1"
   },
+  "optionalDependencies": {
+    "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0"
+  },
   "devDependencies": {
     "@swc/core": "^1.3.83",
     "@swc/jest": "^0.2.29",
     "@types/jest": "^27.5.2",
     "@types/node": "^16.18.50",
     "@types/node-fetch": "^2.6.4",
-    "@wix/ecom": "^1.0.350",
+    "@wix/ecom": "^1.0.353",
     "@wix/events": "^1.0.117",
     "@wix/metro": "^1.0.67",
     "eslint": "^7.32.0",
     "eslint-config-sdk": "0.0.0",
+    "graphql": "16.8.0",
     "is-ci": "^3.0.1",
     "jest": "^27.5.1",
     "jest-teamcity": "^1.11.0",
@@ -83,5 +87,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "e29cd59910eaf06e19edd72d4a7e2cfb431c4a4e6ebb29eeff606342"
+  "falconPackageHash": "979b294b107b16bf496a7f4a836bf08aae79eb2ceba6528b9424a8a6"
 }