@wix/auto_sdk_duplexer_realtime-permissions-provider 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,7 @@
+import { p as provideHandlers$1 } from './service-plugins-error-classes-D9-2LCrZ.js';
+export { A as AlternativeUri, a as Channel, C as CheckSubscriberPermissionsRequest, c as CheckSubscriberPermissionsResponse, e as Context, f as IdentificationData, g as IdentificationDataIdOneOf, I as IdentityType, h as InvalidArgumentWixError, R as RealtimePermissionsProviderConfig, d as SpiBaseUri, S as Subscriber, b as SubscriberType } from './service-plugins-error-classes-D9-2LCrZ.js';
+import { BuildServicePluginDefinition } from '@wix/sdk-types';
+
+declare const provideHandlers: BuildServicePluginDefinition<typeof provideHandlers$1> & typeof provideHandlers$1;
+
+export { provideHandlers, provideHandlers$1 as publicProvideHandlers };

package/build/cjs/index.js

@@ -0,0 +1,99 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.ts
+var index_exports = {};
+__export(index_exports, {
+  IdentityType: () => IdentityType,
+  InvalidArgumentWixError: () => InvalidArgumentWixError,
+  SubscriberType: () => SubscriberType,
+  provideHandlers: () => provideHandlers2,
+  publicProvideHandlers: () => provideHandlers
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/service-plugins-types.ts
+var SubscriberType = /* @__PURE__ */ ((SubscriberType2) => {
+  SubscriberType2["SUBSCRIBER_TYPE_UNSPECIFIED"] = "SUBSCRIBER_TYPE_UNSPECIFIED";
+  SubscriberType2["ADMIN"] = "ADMIN";
+  SubscriberType2["MEMBER"] = "MEMBER";
+  SubscriberType2["VISITOR"] = "VISITOR";
+  return SubscriberType2;
+})(SubscriberType || {});
+var IdentityType = /* @__PURE__ */ ((IdentityType2) => {
+  IdentityType2["UNKNOWN"] = "UNKNOWN";
+  IdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+  IdentityType2["MEMBER"] = "MEMBER";
+  IdentityType2["WIX_USER"] = "WIX_USER";
+  IdentityType2["APP"] = "APP";
+  return IdentityType2;
+})(IdentityType || {});
+
+// src/interfaces-realtime-v1-realtime-permissions-provider.public.ts
+var import_sdk_types = require("@wix/sdk-types");
+var import_rename_all_nested_keys = require("@wix/sdk-runtime/rename-all-nested-keys");
+var provideHandlers = (0, import_sdk_types.ServicePluginDefinition)("REALTIME_PERMISSIONS_PROVIDER", [
+  {
+    name: "checkSubscriberPermissions",
+    primaryHttpMappingPath: "/v1/check-subscriber-permissions",
+    transformations: {
+      toREST: (payload) => {
+        const toRestResponse = payload;
+        return (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)(toRestResponse);
+      },
+      fromREST: (payload) => {
+        const fromRestRequest = payload;
+        return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(fromRestRequest);
+      }
+    }
+  }
+]);
+
+// src/interfaces-realtime-v1-realtime-permissions-provider.context.ts
+var import_service_plugin_modules = require("@wix/sdk-runtime/service-plugin-modules");
+var provideHandlers2 = (0, import_service_plugin_modules.createServicePluginModule)(
+  provideHandlers
+);
+
+// src/service-plugins-error-classes.ts
+var InvalidArgumentWixError = class extends Error {
+  constructor() {
+    super("InvalidArgumentError");
+    this.httpCode = 400;
+    this.statusCode = "INVALID_ARGUMENT";
+    this.applicationCode = "INVALID_ARGUMENT";
+    this.name = "InvalidArgumentError";
+    this.errorType = "SPI";
+    this.spiErrorData = {
+      name: "InvalidArgumentError",
+      applicationCode: "INVALID_ARGUMENT"
+    };
+  }
+};
+/** @hidden */
+InvalidArgumentWixError.__type = "wix_spi_error";
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  IdentityType,
+  InvalidArgumentWixError,
+  SubscriberType,
+  provideHandlers,
+  publicProvideHandlers
+});
+//# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts","../../src/service-plugins-types.ts","../../src/interfaces-realtime-v1-realtime-permissions-provider.public.ts","../../src/interfaces-realtime-v1-realtime-permissions-provider.context.ts","../../src/service-plugins-error-classes.ts"],"sourcesContent":["export * from './src/service-plugins-types.js';\nexport * from './src/interfaces-realtime-v1-realtime-permissions-provider.context.js';\nexport * from './src/service-plugins-error-classes.js';\n","/** Request to check subscriber permissions for a realtime channel. */\nexport interface CheckSubscriberPermissionsRequest {\n  /** The channel to check permissions for */\n  channel?: Channel;\n  /** The subscriber requesting access */\n  subscriber?: Subscriber;\n}\n\nexport interface Channel {\n  /**\n   * Channel name. Cannot exceed 140 characters\n   * @maxLength 140\n   */\n  name?: string;\n  /**\n   * ID of a specific channel resource\n   * @maxLength 1000\n   */\n  resourceId?: string | null;\n}\n\nexport interface Subscriber {\n  /**\n   * The subscriber's user ID\n   * @maxLength 1000\n   */\n  _id?: string;\n  /** The type of subscriber */\n  type?: SubscriberType;\n}\n\nexport enum SubscriberType {\n  SUBSCRIBER_TYPE_UNSPECIFIED = 'SUBSCRIBER_TYPE_UNSPECIFIED',\n  /** Subscriber is the site owner */\n  ADMIN = 'ADMIN',\n  /** Subscriber is a logged-in site member */\n  MEMBER = 'MEMBER',\n  /** Subscriber is not logged in */\n  VISITOR = 'VISITOR',\n}\n\n/** Response containing the subscriber's permissions for the channel. */\nexport interface CheckSubscriberPermissionsResponse {\n  /** Whether the subscriber can listen/read messages */\n  read?: boolean;\n  /** Whether the subscriber can send client events */\n  write?: boolean;\n}\n\nexport interface RealtimePermissionsProviderConfig {\n  /** URI where the SPI Implementer is deployed */\n  deploymentUri?: SpiBaseUri;\n  /**\n   * User-friendly name of the permissions provider\n   * @maxLength 100\n   */\n  providerName?: string;\n}\n\nexport interface SpiBaseUri {\n  /**\n   * Base URI where the methods are called. Wix appends the path to the `baseUri`.\n   * For example, to call the Get Shipping Rates method at `https://my-shipping-provider.com/v1/getRates`, the base URI you provide here is `https://my-shipping-provider.com/`.\n   * @minLength 6\n   * @maxLength 2048\n   */\n  baseUri?: string;\n  /** Alternate, custom URIs to replace the default URIs for specific service plugin methods. */\n  alternativeUris?: AlternativeUri[];\n}\n\nexport interface AlternativeUri {\n  /**\n   * Name of the method to create a custom URI for.\n   *\n   * For `methodName`, use the name of the method in PascalCase.\n   * For example, for Get Shipping Rates use `GetShippingRates`.\n   * @minLength 3\n   * @maxLength 128\n   */\n  methodName?: string;\n  /**\n   * Custom URI that Wix uses to call your server for this method. The path-suffix documented in the method will not be appended to this URI.\n   * Must be a secured endpoint beginning with `https://`. For example, `https://www.my-shipping-provider.com/my-shipping-rates`.\n   * @minLength 6\n   * @maxLength 2048\n   */\n  absoluteUri?: string;\n}\n\n/**\n * this message is not directly used by any service,\n * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.\n * e.g. SPIs, event-handlers, etc..\n * NOTE: this context object MUST be provided as the last argument in each Velo method signature.\n *\n * Example:\n * ```typescript\n * export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {\n * ...\n * }\n * ```\n */\nexport interface Context {\n  /** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */\n  requestId?: string | null;\n  /**\n   * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code.\n   * @format CURRENCY\n   */\n  currency?: string | null;\n  /** An object that describes the identity that triggered this request. */\n  identity?: IdentificationData;\n  /** A string representing a language and region in the format of `\"xx-XX\"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash \"-\", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `\"en-US\"`. */\n  languages?: string[];\n  /**\n   * The service provider app's instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n}\n\nexport enum IdentityType {\n  UNKNOWN = 'UNKNOWN',\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  MEMBER = 'MEMBER',\n  WIX_USER = 'WIX_USER',\n  APP = 'APP',\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n  /** @readonly */\n  identityType?: IdentityType;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n}\n","import { ServicePluginDefinition } from '@wix/sdk-types';\nimport {\n  Context,\n  CheckSubscriberPermissionsRequest,\n  CheckSubscriberPermissionsResponse,\n} from './service-plugins-types.js';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\n\nexport interface CheckSubscriberPermissionsEnvelope {\n  request: CheckSubscriberPermissionsRequest;\n  metadata: Context;\n}\n\nexport const provideHandlers = ServicePluginDefinition<{\n  /**\n   *\n   * Checks whether a subscriber has permission to access a realtime channel.\n   *\n   * The Realtime Permissions Provider extension allows apps to control access\n   * to realtime channels. When a subscriber attempts to connect to a channel,\n   * this method is called to determine whether the subscriber has read and/or\n   * write permissions for the specified channel.\n   *\n   * Parameter: A `CheckSubscriberPermissionsRequest` object containing the\n   * channel and subscriber details.\n   * Response: A `CheckSubscriberPermissionsResponse` object containing the\n   * read and write permissions:\n   * ```json\n   * {\n   * \"read\": true,\n   * \"write\": false\n   * }\n   * ``` */\n  checkSubscriberPermissions(\n    payload: CheckSubscriberPermissionsEnvelope\n  ):\n    | CheckSubscriberPermissionsResponse\n    | Promise<CheckSubscriberPermissionsResponse>;\n}>('REALTIME_PERMISSIONS_PROVIDER', [\n  {\n    name: 'checkSubscriberPermissions',\n    primaryHttpMappingPath: '/v1/check-subscriber-permissions',\n    transformations: {\n      toREST: (payload: any) => {\n        const toRestResponse = payload;\n\n        return renameKeysFromSDKRequestToRESTRequest(toRestResponse);\n      },\n      fromREST: (payload: any) => {\n        const fromRestRequest = payload;\n\n        return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);\n      },\n    },\n  },\n]);\n","import './interfaces-realtime-v1-realtime-permissions-provider.public.js';\nimport { createServicePluginModule } from '@wix/sdk-runtime/service-plugin-modules';\nimport { BuildServicePluginDefinition } from '@wix/sdk-types';\nimport { provideHandlers as publicProvideHandlers } from './interfaces-realtime-v1-realtime-permissions-provider.public.js';\n\nexport { publicProvideHandlers };\n\nexport const provideHandlers: BuildServicePluginDefinition<\n  typeof publicProvideHandlers\n> &\n  typeof publicProvideHandlers = createServicePluginModule(\n  publicProvideHandlers\n);\n","export class InvalidArgumentWixError extends Error {\n  /** @hidden */\n  httpCode: number;\n  /** @hidden */\n  statusCode: string;\n  /** @hidden */\n  applicationCode: string;\n  /** @hidden */\n  name: string;\n  /** @hidden */\n  errorType: string;\n  /** @hidden */\n  spiErrorData: object;\n\n  constructor() {\n    super('InvalidArgumentError');\n\n    this.httpCode = 400;\n    this.statusCode = 'INVALID_ARGUMENT';\n    this.applicationCode = 'INVALID_ARGUMENT';\n    this.name = 'InvalidArgumentError';\n    this.errorType = 'SPI';\n    this.spiErrorData = {\n      name: 'InvalidArgumentError',\n      applicationCode: 'INVALID_ARGUMENT',\n    };\n  }\n\n  /** @hidden */\n  static readonly __type = 'wix_spi_error';\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAAAA;AAAA,EAAA;AAAA;AAAA;;;AC+BO,IAAK,iBAAL,kBAAKC,oBAAL;AACL,EAAAA,gBAAA,iCAA8B;AAE9B,EAAAA,gBAAA,WAAQ;AAER,EAAAA,gBAAA,YAAS;AAET,EAAAA,gBAAA,aAAU;AAPA,SAAAA;AAAA,GAAA;AA2FL,IAAK,eAAL,kBAAKC,kBAAL;AACL,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,uBAAoB;AACpB,EAAAA,cAAA,YAAS;AACT,EAAAA,cAAA,cAAW;AACX,EAAAA,cAAA,SAAM;AALI,SAAAA;AAAA,GAAA;;;AC1HZ,uBAAwC;AAMxC,oCAGO;AAOA,IAAM,sBAAkB,0CAyB5B,iCAAiC;AAAA,EAClC;AAAA,IACE,MAAM;AAAA,IACN,wBAAwB;AAAA,IACxB,iBAAiB;AAAA,MACf,QAAQ,CAAC,YAAiB;AACxB,cAAM,iBAAiB;AAEvB,mBAAO,qEAAsC,cAAc;AAAA,MAC7D;AAAA,MACA,UAAU,CAAC,YAAiB;AAC1B,cAAM,kBAAkB;AAExB,mBAAO,uEAAwC,eAAe;AAAA,MAChE;AAAA,IACF;AAAA,EACF;AACF,CAAC;;;ACzDD,oCAA0C;AAMnC,IAAMC,uBAGoB;AAAA,EAC/B;AACF;;;ACZO,IAAM,0BAAN,cAAsC,MAAM;AAAA,EAcjD,cAAc;AACZ,UAAM,sBAAsB;AAE5B,SAAK,WAAW;AAChB,SAAK,aAAa;AAClB,SAAK,kBAAkB;AACvB,SAAK,OAAO;AACZ,SAAK,YAAY;AACjB,SAAK,eAAe;AAAA,MAClB,MAAM;AAAA,MACN,iBAAiB;AAAA,IACnB;AAAA,EACF;AAIF;AAAA;AA9Ba,wBA6BK,SAAS;","names":["provideHandlers","SubscriberType","IdentityType","provideHandlers"]}

package/build/cjs/index.typings.d.ts

@@ -0,0 +1,27 @@
+import { i as CheckSubscriberPermissionsEnvelope, c as CheckSubscriberPermissionsResponse } from './service-plugins-error-classes-D9-2LCrZ.js';
+export { A as AlternativeUri, a as Channel, C as CheckSubscriberPermissionsRequest, e as Context, f as IdentificationData, g as IdentificationDataIdOneOf, I as IdentityType, h as InvalidArgumentWixError, R as RealtimePermissionsProviderConfig, d as SpiBaseUri, S as Subscriber, b as SubscriberType } from './service-plugins-error-classes-D9-2LCrZ.js';
+import '@wix/sdk-types';
+
+/**
+ * Checks whether a subscriber has permission to access a realtime channel.
+ *
+ * The Realtime Permissions Provider extension allows apps to control access
+ * to realtime channels. When a subscriber attempts to connect to a channel,
+ * this method is called to determine whether the subscriber has read and/or
+ * write permissions for the specified channel.
+ *
+ * Parameter: A `CheckSubscriberPermissionsRequest` object containing the
+ * channel and subscriber details.
+ * Response: A `CheckSubscriberPermissionsResponse` object containing the
+ * read and write permissions:
+ * ```json
+ * {
+ * "read": true,
+ * "write": false
+ * }
+ * ```
+ * @throws InvalidArgumentWixError
+ */
+declare function checkSubscriberPermissions(payload: CheckSubscriberPermissionsEnvelope): CheckSubscriberPermissionsResponse | Promise<CheckSubscriberPermissionsResponse>;
+
+export { CheckSubscriberPermissionsEnvelope, CheckSubscriberPermissionsResponse, checkSubscriberPermissions };

package/build/cjs/index.typings.js

@@ -0,0 +1,69 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.typings.ts
+var index_typings_exports = {};
+__export(index_typings_exports, {
+  IdentityType: () => IdentityType,
+  InvalidArgumentWixError: () => InvalidArgumentWixError,
+  SubscriberType: () => SubscriberType
+});
+module.exports = __toCommonJS(index_typings_exports);
+
+// src/service-plugins-error-classes.ts
+var InvalidArgumentWixError = class extends Error {
+  constructor() {
+    super("InvalidArgumentError");
+    this.httpCode = 400;
+    this.statusCode = "INVALID_ARGUMENT";
+    this.applicationCode = "INVALID_ARGUMENT";
+    this.name = "InvalidArgumentError";
+    this.errorType = "SPI";
+    this.spiErrorData = {
+      name: "InvalidArgumentError",
+      applicationCode: "INVALID_ARGUMENT"
+    };
+  }
+};
+/** @hidden */
+InvalidArgumentWixError.__type = "wix_spi_error";
+
+// src/service-plugins-types.ts
+var SubscriberType = /* @__PURE__ */ ((SubscriberType2) => {
+  SubscriberType2["SUBSCRIBER_TYPE_UNSPECIFIED"] = "SUBSCRIBER_TYPE_UNSPECIFIED";
+  SubscriberType2["ADMIN"] = "ADMIN";
+  SubscriberType2["MEMBER"] = "MEMBER";
+  SubscriberType2["VISITOR"] = "VISITOR";
+  return SubscriberType2;
+})(SubscriberType || {});
+var IdentityType = /* @__PURE__ */ ((IdentityType2) => {
+  IdentityType2["UNKNOWN"] = "UNKNOWN";
+  IdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+  IdentityType2["MEMBER"] = "MEMBER";
+  IdentityType2["WIX_USER"] = "WIX_USER";
+  IdentityType2["APP"] = "APP";
+  return IdentityType2;
+})(IdentityType || {});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  IdentityType,
+  InvalidArgumentWixError,
+  SubscriberType
+});
+//# sourceMappingURL=index.typings.js.map

package/build/cjs/index.typings.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.typings.ts","../../src/service-plugins-error-classes.ts","../../src/service-plugins-types.ts"],"sourcesContent":["import { CheckSubscriberPermissionsResponse } from './src/service-plugins-types.js';\nimport { CheckSubscriberPermissionsEnvelope } from './src/interfaces-realtime-v1-realtime-permissions-provider.public.js';\n\nexport * from './src/service-plugins-error-classes';\nexport * from './src/service-plugins-types';\nexport { CheckSubscriberPermissionsEnvelope };\n\n/**\n * Checks whether a subscriber has permission to access a realtime channel.\n *\n * The Realtime Permissions Provider extension allows apps to control access\n * to realtime channels. When a subscriber attempts to connect to a channel,\n * this method is called to determine whether the subscriber has read and/or\n * write permissions for the specified channel.\n *\n * Parameter: A `CheckSubscriberPermissionsRequest` object containing the\n * channel and subscriber details.\n * Response: A `CheckSubscriberPermissionsResponse` object containing the\n * read and write permissions:\n * ```json\n * {\n * \"read\": true,\n * \"write\": false\n * }\n * ```\n * @throws InvalidArgumentWixError\n */\nexport declare function checkSubscriberPermissions(\n  payload: CheckSubscriberPermissionsEnvelope\n):\n  | CheckSubscriberPermissionsResponse\n  | Promise<CheckSubscriberPermissionsResponse>;\n","export class InvalidArgumentWixError extends Error {\n  /** @hidden */\n  httpCode: number;\n  /** @hidden */\n  statusCode: string;\n  /** @hidden */\n  applicationCode: string;\n  /** @hidden */\n  name: string;\n  /** @hidden */\n  errorType: string;\n  /** @hidden */\n  spiErrorData: object;\n\n  constructor() {\n    super('InvalidArgumentError');\n\n    this.httpCode = 400;\n    this.statusCode = 'INVALID_ARGUMENT';\n    this.applicationCode = 'INVALID_ARGUMENT';\n    this.name = 'InvalidArgumentError';\n    this.errorType = 'SPI';\n    this.spiErrorData = {\n      name: 'InvalidArgumentError',\n      applicationCode: 'INVALID_ARGUMENT',\n    };\n  }\n\n  /** @hidden */\n  static readonly __type = 'wix_spi_error';\n}\n","/** Request to check subscriber permissions for a realtime channel. */\nexport interface CheckSubscriberPermissionsRequest {\n  /** The channel to check permissions for */\n  channel?: Channel;\n  /** The subscriber requesting access */\n  subscriber?: Subscriber;\n}\n\nexport interface Channel {\n  /**\n   * Channel name. Cannot exceed 140 characters\n   * @maxLength 140\n   */\n  name?: string;\n  /**\n   * ID of a specific channel resource\n   * @maxLength 1000\n   */\n  resourceId?: string | null;\n}\n\nexport interface Subscriber {\n  /**\n   * The subscriber's user ID\n   * @maxLength 1000\n   */\n  _id?: string;\n  /** The type of subscriber */\n  type?: SubscriberType;\n}\n\nexport enum SubscriberType {\n  SUBSCRIBER_TYPE_UNSPECIFIED = 'SUBSCRIBER_TYPE_UNSPECIFIED',\n  /** Subscriber is the site owner */\n  ADMIN = 'ADMIN',\n  /** Subscriber is a logged-in site member */\n  MEMBER = 'MEMBER',\n  /** Subscriber is not logged in */\n  VISITOR = 'VISITOR',\n}\n\n/** Response containing the subscriber's permissions for the channel. */\nexport interface CheckSubscriberPermissionsResponse {\n  /** Whether the subscriber can listen/read messages */\n  read?: boolean;\n  /** Whether the subscriber can send client events */\n  write?: boolean;\n}\n\nexport interface RealtimePermissionsProviderConfig {\n  /** URI where the SPI Implementer is deployed */\n  deploymentUri?: SpiBaseUri;\n  /**\n   * User-friendly name of the permissions provider\n   * @maxLength 100\n   */\n  providerName?: string;\n}\n\nexport interface SpiBaseUri {\n  /**\n   * Base URI where the methods are called. Wix appends the path to the `baseUri`.\n   * For example, to call the Get Shipping Rates method at `https://my-shipping-provider.com/v1/getRates`, the base URI you provide here is `https://my-shipping-provider.com/`.\n   * @minLength 6\n   * @maxLength 2048\n   */\n  baseUri?: string;\n  /** Alternate, custom URIs to replace the default URIs for specific service plugin methods. */\n  alternativeUris?: AlternativeUri[];\n}\n\nexport interface AlternativeUri {\n  /**\n   * Name of the method to create a custom URI for.\n   *\n   * For `methodName`, use the name of the method in PascalCase.\n   * For example, for Get Shipping Rates use `GetShippingRates`.\n   * @minLength 3\n   * @maxLength 128\n   */\n  methodName?: string;\n  /**\n   * Custom URI that Wix uses to call your server for this method. The path-suffix documented in the method will not be appended to this URI.\n   * Must be a secured endpoint beginning with `https://`. For example, `https://www.my-shipping-provider.com/my-shipping-rates`.\n   * @minLength 6\n   * @maxLength 2048\n   */\n  absoluteUri?: string;\n}\n\n/**\n * this message is not directly used by any service,\n * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.\n * e.g. SPIs, event-handlers, etc..\n * NOTE: this context object MUST be provided as the last argument in each Velo method signature.\n *\n * Example:\n * ```typescript\n * export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {\n * ...\n * }\n * ```\n */\nexport interface Context {\n  /** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */\n  requestId?: string | null;\n  /**\n   * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code.\n   * @format CURRENCY\n   */\n  currency?: string | null;\n  /** An object that describes the identity that triggered this request. */\n  identity?: IdentificationData;\n  /** A string representing a language and region in the format of `\"xx-XX\"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash \"-\", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `\"en-US\"`. */\n  languages?: string[];\n  /**\n   * The service provider app's instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n}\n\nexport enum IdentityType {\n  UNKNOWN = 'UNKNOWN',\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  MEMBER = 'MEMBER',\n  WIX_USER = 'WIX_USER',\n  APP = 'APP',\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n  /** @readonly */\n  identityType?: IdentityType;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAO,IAAM,0BAAN,cAAsC,MAAM;AAAA,EAcjD,cAAc;AACZ,UAAM,sBAAsB;AAE5B,SAAK,WAAW;AAChB,SAAK,aAAa;AAClB,SAAK,kBAAkB;AACvB,SAAK,OAAO;AACZ,SAAK,YAAY;AACjB,SAAK,eAAe;AAAA,MAClB,MAAM;AAAA,MACN,iBAAiB;AAAA,IACnB;AAAA,EACF;AAIF;AAAA;AA9Ba,wBA6BK,SAAS;;;ACEpB,IAAK,iBAAL,kBAAKA,oBAAL;AACL,EAAAA,gBAAA,iCAA8B;AAE9B,EAAAA,gBAAA,WAAQ;AAER,EAAAA,gBAAA,YAAS;AAET,EAAAA,gBAAA,aAAU;AAPA,SAAAA;AAAA,GAAA;AA2FL,IAAK,eAAL,kBAAKC,kBAAL;AACL,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,uBAAoB;AACpB,EAAAA,cAAA,YAAS;AACT,EAAAA,cAAA,cAAW;AACX,EAAAA,cAAA,SAAM;AALI,SAAAA;AAAA,GAAA;","names":["SubscriberType","IdentityType"]}

package/build/cjs/service-plugins-error-classes-D9-2LCrZ.d.ts

@@ -0,0 +1,216 @@
+import { ServicePluginDefinition } from '@wix/sdk-types';
+
+/** Request to check subscriber permissions for a realtime channel. */
+interface CheckSubscriberPermissionsRequest {
+    /** The channel to check permissions for */
+    channel?: Channel;
+    /** The subscriber requesting access */
+    subscriber?: Subscriber;
+}
+interface Channel {
+    /**
+     * Channel name. Cannot exceed 140 characters
+     * @maxLength 140
+     */
+    name?: string;
+    /**
+     * ID of a specific channel resource
+     * @maxLength 1000
+     */
+    resourceId?: string | null;
+}
+interface Subscriber {
+    /**
+     * The subscriber's user ID
+     * @maxLength 1000
+     */
+    _id?: string;
+    /** The type of subscriber */
+    type?: SubscriberType;
+}
+declare enum SubscriberType {
+    SUBSCRIBER_TYPE_UNSPECIFIED = "SUBSCRIBER_TYPE_UNSPECIFIED",
+    /** Subscriber is the site owner */
+    ADMIN = "ADMIN",
+    /** Subscriber is a logged-in site member */
+    MEMBER = "MEMBER",
+    /** Subscriber is not logged in */
+    VISITOR = "VISITOR"
+}
+/** Response containing the subscriber's permissions for the channel. */
+interface CheckSubscriberPermissionsResponse {
+    /** Whether the subscriber can listen/read messages */
+    read?: boolean;
+    /** Whether the subscriber can send client events */
+    write?: boolean;
+}
+interface RealtimePermissionsProviderConfig {
+    /** URI where the SPI Implementer is deployed */
+    deploymentUri?: SpiBaseUri;
+    /**
+     * User-friendly name of the permissions provider
+     * @maxLength 100
+     */
+    providerName?: string;
+}
+interface SpiBaseUri {
+    /**
+     * Base URI where the methods are called. Wix appends the path to the `baseUri`.
+     * For example, to call the Get Shipping Rates method at `https://my-shipping-provider.com/v1/getRates`, the base URI you provide here is `https://my-shipping-provider.com/`.
+     * @minLength 6
+     * @maxLength 2048
+     */
+    baseUri?: string;
+    /** Alternate, custom URIs to replace the default URIs for specific service plugin methods. */
+    alternativeUris?: AlternativeUri[];
+}
+interface AlternativeUri {
+    /**
+     * Name of the method to create a custom URI for.
+     *
+     * For `methodName`, use the name of the method in PascalCase.
+     * For example, for Get Shipping Rates use `GetShippingRates`.
+     * @minLength 3
+     * @maxLength 128
+     */
+    methodName?: string;
+    /**
+     * Custom URI that Wix uses to call your server for this method. The path-suffix documented in the method will not be appended to this URI.
+     * Must be a secured endpoint beginning with `https://`. For example, `https://www.my-shipping-provider.com/my-shipping-rates`.
+     * @minLength 6
+     * @maxLength 2048
+     */
+    absoluteUri?: string;
+}
+/**
+ * this message is not directly used by any service,
+ * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.
+ * e.g. SPIs, event-handlers, etc..
+ * NOTE: this context object MUST be provided as the last argument in each Velo method signature.
+ *
+ * Example:
+ * ```typescript
+ * export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {
+ * ...
+ * }
+ * ```
+ */
+interface Context {
+    /** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */
+    requestId?: string | null;
+    /**
+     * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code.
+     * @format CURRENCY
+     */
+    currency?: string | null;
+    /** An object that describes the identity that triggered this request. */
+    identity?: IdentificationData;
+    /** A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. */
+    languages?: string[];
+    /**
+     * The service provider app's instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+}
+declare enum IdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: IdentityType;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+
+interface CheckSubscriberPermissionsEnvelope {
+    request: CheckSubscriberPermissionsRequest;
+    metadata: Context;
+}
+declare const provideHandlers: ServicePluginDefinition<{
+    /**
+     *
+     * Checks whether a subscriber has permission to access a realtime channel.
+     *
+     * The Realtime Permissions Provider extension allows apps to control access
+     * to realtime channels. When a subscriber attempts to connect to a channel,
+     * this method is called to determine whether the subscriber has read and/or
+     * write permissions for the specified channel.
+     *
+     * Parameter: A `CheckSubscriberPermissionsRequest` object containing the
+     * channel and subscriber details.
+     * Response: A `CheckSubscriberPermissionsResponse` object containing the
+     * read and write permissions:
+     * ```json
+     * {
+     * "read": true,
+     * "write": false
+     * }
+     * ``` */
+    checkSubscriberPermissions(payload: CheckSubscriberPermissionsEnvelope): CheckSubscriberPermissionsResponse | Promise<CheckSubscriberPermissionsResponse>;
+}>;
+
+declare class InvalidArgumentWixError extends Error {
+    /** @hidden */
+    httpCode: number;
+    /** @hidden */
+    statusCode: string;
+    /** @hidden */
+    applicationCode: string;
+    /** @hidden */
+    name: string;
+    /** @hidden */
+    errorType: string;
+    /** @hidden */
+    spiErrorData: object;
+    constructor();
+    /** @hidden */
+    static readonly __type = "wix_spi_error";
+}
+
+export { type AlternativeUri as A, type CheckSubscriberPermissionsRequest as C, IdentityType as I, type RealtimePermissionsProviderConfig as R, type Subscriber as S, type Channel as a, SubscriberType as b, type CheckSubscriberPermissionsResponse as c, type SpiBaseUri as d, type Context as e, type IdentificationData as f, type IdentificationDataIdOneOf as g, InvalidArgumentWixError as h, type CheckSubscriberPermissionsEnvelope as i, provideHandlers as p };

package/build/es/index.d.mts

@@ -0,0 +1,7 @@
+import { p as provideHandlers$1 } from './service-plugins-error-classes-D9-2LCrZ.mjs';
+export { A as AlternativeUri, a as Channel, C as CheckSubscriberPermissionsRequest, c as CheckSubscriberPermissionsResponse, e as Context, f as IdentificationData, g as IdentificationDataIdOneOf, I as IdentityType, h as InvalidArgumentWixError, R as RealtimePermissionsProviderConfig, d as SpiBaseUri, S as Subscriber, b as SubscriberType } from './service-plugins-error-classes-D9-2LCrZ.mjs';
+import { BuildServicePluginDefinition } from '@wix/sdk-types';
+
+declare const provideHandlers: BuildServicePluginDefinition<typeof provideHandlers$1> & typeof provideHandlers$1;
+
+export { provideHandlers, provideHandlers$1 as publicProvideHandlers };

package/build/es/index.mjs

@@ -0,0 +1,71 @@
+// src/service-plugins-types.ts
+var SubscriberType = /* @__PURE__ */ ((SubscriberType2) => {
+  SubscriberType2["SUBSCRIBER_TYPE_UNSPECIFIED"] = "SUBSCRIBER_TYPE_UNSPECIFIED";
+  SubscriberType2["ADMIN"] = "ADMIN";
+  SubscriberType2["MEMBER"] = "MEMBER";
+  SubscriberType2["VISITOR"] = "VISITOR";
+  return SubscriberType2;
+})(SubscriberType || {});
+var IdentityType = /* @__PURE__ */ ((IdentityType2) => {
+  IdentityType2["UNKNOWN"] = "UNKNOWN";
+  IdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+  IdentityType2["MEMBER"] = "MEMBER";
+  IdentityType2["WIX_USER"] = "WIX_USER";
+  IdentityType2["APP"] = "APP";
+  return IdentityType2;
+})(IdentityType || {});
+
+// src/interfaces-realtime-v1-realtime-permissions-provider.public.ts
+import { ServicePluginDefinition } from "@wix/sdk-types";
+import {
+  renameKeysFromSDKRequestToRESTRequest,
+  renameKeysFromRESTResponseToSDKResponse
+} from "@wix/sdk-runtime/rename-all-nested-keys";
+var provideHandlers = ServicePluginDefinition("REALTIME_PERMISSIONS_PROVIDER", [
+  {
+    name: "checkSubscriberPermissions",
+    primaryHttpMappingPath: "/v1/check-subscriber-permissions",
+    transformations: {
+      toREST: (payload) => {
+        const toRestResponse = payload;
+        return renameKeysFromSDKRequestToRESTRequest(toRestResponse);
+      },
+      fromREST: (payload) => {
+        const fromRestRequest = payload;
+        return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);
+      }
+    }
+  }
+]);
+
+// src/interfaces-realtime-v1-realtime-permissions-provider.context.ts
+import { createServicePluginModule } from "@wix/sdk-runtime/service-plugin-modules";
+var provideHandlers2 = createServicePluginModule(
+  provideHandlers
+);
+
+// src/service-plugins-error-classes.ts
+var InvalidArgumentWixError = class extends Error {
+  constructor() {
+    super("InvalidArgumentError");
+    this.httpCode = 400;
+    this.statusCode = "INVALID_ARGUMENT";
+    this.applicationCode = "INVALID_ARGUMENT";
+    this.name = "InvalidArgumentError";
+    this.errorType = "SPI";
+    this.spiErrorData = {
+      name: "InvalidArgumentError",
+      applicationCode: "INVALID_ARGUMENT"
+    };
+  }
+};
+/** @hidden */
+InvalidArgumentWixError.__type = "wix_spi_error";
+export {
+  IdentityType,
+  InvalidArgumentWixError,
+  SubscriberType,
+  provideHandlers2 as provideHandlers,
+  provideHandlers as publicProvideHandlers
+};
+//# sourceMappingURL=index.mjs.map

package/build/es/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/service-plugins-types.ts","../../src/interfaces-realtime-v1-realtime-permissions-provider.public.ts","../../src/interfaces-realtime-v1-realtime-permissions-provider.context.ts","../../src/service-plugins-error-classes.ts"],"sourcesContent":["/** Request to check subscriber permissions for a realtime channel. */\nexport interface CheckSubscriberPermissionsRequest {\n  /** The channel to check permissions for */\n  channel?: Channel;\n  /** The subscriber requesting access */\n  subscriber?: Subscriber;\n}\n\nexport interface Channel {\n  /**\n   * Channel name. Cannot exceed 140 characters\n   * @maxLength 140\n   */\n  name?: string;\n  /**\n   * ID of a specific channel resource\n   * @maxLength 1000\n   */\n  resourceId?: string | null;\n}\n\nexport interface Subscriber {\n  /**\n   * The subscriber's user ID\n   * @maxLength 1000\n   */\n  _id?: string;\n  /** The type of subscriber */\n  type?: SubscriberType;\n}\n\nexport enum SubscriberType {\n  SUBSCRIBER_TYPE_UNSPECIFIED = 'SUBSCRIBER_TYPE_UNSPECIFIED',\n  /** Subscriber is the site owner */\n  ADMIN = 'ADMIN',\n  /** Subscriber is a logged-in site member */\n  MEMBER = 'MEMBER',\n  /** Subscriber is not logged in */\n  VISITOR = 'VISITOR',\n}\n\n/** Response containing the subscriber's permissions for the channel. */\nexport interface CheckSubscriberPermissionsResponse {\n  /** Whether the subscriber can listen/read messages */\n  read?: boolean;\n  /** Whether the subscriber can send client events */\n  write?: boolean;\n}\n\nexport interface RealtimePermissionsProviderConfig {\n  /** URI where the SPI Implementer is deployed */\n  deploymentUri?: SpiBaseUri;\n  /**\n   * User-friendly name of the permissions provider\n   * @maxLength 100\n   */\n  providerName?: string;\n}\n\nexport interface SpiBaseUri {\n  /**\n   * Base URI where the methods are called. Wix appends the path to the `baseUri`.\n   * For example, to call the Get Shipping Rates method at `https://my-shipping-provider.com/v1/getRates`, the base URI you provide here is `https://my-shipping-provider.com/`.\n   * @minLength 6\n   * @maxLength 2048\n   */\n  baseUri?: string;\n  /** Alternate, custom URIs to replace the default URIs for specific service plugin methods. */\n  alternativeUris?: AlternativeUri[];\n}\n\nexport interface AlternativeUri {\n  /**\n   * Name of the method to create a custom URI for.\n   *\n   * For `methodName`, use the name of the method in PascalCase.\n   * For example, for Get Shipping Rates use `GetShippingRates`.\n   * @minLength 3\n   * @maxLength 128\n   */\n  methodName?: string;\n  /**\n   * Custom URI that Wix uses to call your server for this method. The path-suffix documented in the method will not be appended to this URI.\n   * Must be a secured endpoint beginning with `https://`. For example, `https://www.my-shipping-provider.com/my-shipping-rates`.\n   * @minLength 6\n   * @maxLength 2048\n   */\n  absoluteUri?: string;\n}\n\n/**\n * this message is not directly used by any service,\n * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.\n * e.g. SPIs, event-handlers, etc..\n * NOTE: this context object MUST be provided as the last argument in each Velo method signature.\n *\n * Example:\n * ```typescript\n * export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {\n * ...\n * }\n * ```\n */\nexport interface Context {\n  /** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */\n  requestId?: string | null;\n  /**\n   * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code.\n   * @format CURRENCY\n   */\n  currency?: string | null;\n  /** An object that describes the identity that triggered this request. */\n  identity?: IdentificationData;\n  /** A string representing a language and region in the format of `\"xx-XX\"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash \"-\", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `\"en-US\"`. */\n  languages?: string[];\n  /**\n   * The service provider app's instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n}\n\nexport enum IdentityType {\n  UNKNOWN = 'UNKNOWN',\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  MEMBER = 'MEMBER',\n  WIX_USER = 'WIX_USER',\n  APP = 'APP',\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n  /** @readonly */\n  identityType?: IdentityType;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n}\n","import { ServicePluginDefinition } from '@wix/sdk-types';\nimport {\n  Context,\n  CheckSubscriberPermissionsRequest,\n  CheckSubscriberPermissionsResponse,\n} from './service-plugins-types.js';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\n\nexport interface CheckSubscriberPermissionsEnvelope {\n  request: CheckSubscriberPermissionsRequest;\n  metadata: Context;\n}\n\nexport const provideHandlers = ServicePluginDefinition<{\n  /**\n   *\n   * Checks whether a subscriber has permission to access a realtime channel.\n   *\n   * The Realtime Permissions Provider extension allows apps to control access\n   * to realtime channels. When a subscriber attempts to connect to a channel,\n   * this method is called to determine whether the subscriber has read and/or\n   * write permissions for the specified channel.\n   *\n   * Parameter: A `CheckSubscriberPermissionsRequest` object containing the\n   * channel and subscriber details.\n   * Response: A `CheckSubscriberPermissionsResponse` object containing the\n   * read and write permissions:\n   * ```json\n   * {\n   * \"read\": true,\n   * \"write\": false\n   * }\n   * ``` */\n  checkSubscriberPermissions(\n    payload: CheckSubscriberPermissionsEnvelope\n  ):\n    | CheckSubscriberPermissionsResponse\n    | Promise<CheckSubscriberPermissionsResponse>;\n}>('REALTIME_PERMISSIONS_PROVIDER', [\n  {\n    name: 'checkSubscriberPermissions',\n    primaryHttpMappingPath: '/v1/check-subscriber-permissions',\n    transformations: {\n      toREST: (payload: any) => {\n        const toRestResponse = payload;\n\n        return renameKeysFromSDKRequestToRESTRequest(toRestResponse);\n      },\n      fromREST: (payload: any) => {\n        const fromRestRequest = payload;\n\n        return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);\n      },\n    },\n  },\n]);\n","import './interfaces-realtime-v1-realtime-permissions-provider.public.js';\nimport { createServicePluginModule } from '@wix/sdk-runtime/service-plugin-modules';\nimport { BuildServicePluginDefinition } from '@wix/sdk-types';\nimport { provideHandlers as publicProvideHandlers } from './interfaces-realtime-v1-realtime-permissions-provider.public.js';\n\nexport { publicProvideHandlers };\n\nexport const provideHandlers: BuildServicePluginDefinition<\n  typeof publicProvideHandlers\n> &\n  typeof publicProvideHandlers = createServicePluginModule(\n  publicProvideHandlers\n);\n","export class InvalidArgumentWixError extends Error {\n  /** @hidden */\n  httpCode: number;\n  /** @hidden */\n  statusCode: string;\n  /** @hidden */\n  applicationCode: string;\n  /** @hidden */\n  name: string;\n  /** @hidden */\n  errorType: string;\n  /** @hidden */\n  spiErrorData: object;\n\n  constructor() {\n    super('InvalidArgumentError');\n\n    this.httpCode = 400;\n    this.statusCode = 'INVALID_ARGUMENT';\n    this.applicationCode = 'INVALID_ARGUMENT';\n    this.name = 'InvalidArgumentError';\n    this.errorType = 'SPI';\n    this.spiErrorData = {\n      name: 'InvalidArgumentError',\n      applicationCode: 'INVALID_ARGUMENT',\n    };\n  }\n\n  /** @hidden */\n  static readonly __type = 'wix_spi_error';\n}\n"],"mappings":";AA+BO,IAAK,iBAAL,kBAAKA,oBAAL;AACL,EAAAA,gBAAA,iCAA8B;AAE9B,EAAAA,gBAAA,WAAQ;AAER,EAAAA,gBAAA,YAAS;AAET,EAAAA,gBAAA,aAAU;AAPA,SAAAA;AAAA,GAAA;AA2FL,IAAK,eAAL,kBAAKC,kBAAL;AACL,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,uBAAoB;AACpB,EAAAA,cAAA,YAAS;AACT,EAAAA,cAAA,cAAW;AACX,EAAAA,cAAA,SAAM;AALI,SAAAA;AAAA,GAAA;;;AC1HZ,SAAS,+BAA+B;AAMxC;AAAA,EACE;AAAA,EACA;AAAA,OACK;AAOA,IAAM,kBAAkB,wBAyB5B,iCAAiC;AAAA,EAClC;AAAA,IACE,MAAM;AAAA,IACN,wBAAwB;AAAA,IACxB,iBAAiB;AAAA,MACf,QAAQ,CAAC,YAAiB;AACxB,cAAM,iBAAiB;AAEvB,eAAO,sCAAsC,cAAc;AAAA,MAC7D;AAAA,MACA,UAAU,CAAC,YAAiB;AAC1B,cAAM,kBAAkB;AAExB,eAAO,wCAAwC,eAAe;AAAA,MAChE;AAAA,IACF;AAAA,EACF;AACF,CAAC;;;ACzDD,SAAS,iCAAiC;AAMnC,IAAMC,mBAGoB;AAAA,EAC/B;AACF;;;ACZO,IAAM,0BAAN,cAAsC,MAAM;AAAA,EAcjD,cAAc;AACZ,UAAM,sBAAsB;AAE5B,SAAK,WAAW;AAChB,SAAK,aAAa;AAClB,SAAK,kBAAkB;AACvB,SAAK,OAAO;AACZ,SAAK,YAAY;AACjB,SAAK,eAAe;AAAA,MAClB,MAAM;AAAA,MACN,iBAAiB;AAAA,IACnB;AAAA,EACF;AAIF;AAAA;AA9Ba,wBA6BK,SAAS;","names":["SubscriberType","IdentityType","provideHandlers"]}

package/build/es/index.typings.d.mts

@@ -0,0 +1,27 @@
+import { i as CheckSubscriberPermissionsEnvelope, c as CheckSubscriberPermissionsResponse } from './service-plugins-error-classes-D9-2LCrZ.mjs';
+export { A as AlternativeUri, a as Channel, C as CheckSubscriberPermissionsRequest, e as Context, f as IdentificationData, g as IdentificationDataIdOneOf, I as IdentityType, h as InvalidArgumentWixError, R as RealtimePermissionsProviderConfig, d as SpiBaseUri, S as Subscriber, b as SubscriberType } from './service-plugins-error-classes-D9-2LCrZ.mjs';
+import '@wix/sdk-types';
+
+/**
+ * Checks whether a subscriber has permission to access a realtime channel.
+ *
+ * The Realtime Permissions Provider extension allows apps to control access
+ * to realtime channels. When a subscriber attempts to connect to a channel,
+ * this method is called to determine whether the subscriber has read and/or
+ * write permissions for the specified channel.
+ *
+ * Parameter: A `CheckSubscriberPermissionsRequest` object containing the
+ * channel and subscriber details.
+ * Response: A `CheckSubscriberPermissionsResponse` object containing the
+ * read and write permissions:
+ * ```json
+ * {
+ * "read": true,
+ * "write": false
+ * }
+ * ```
+ * @throws InvalidArgumentWixError
+ */
+declare function checkSubscriberPermissions(payload: CheckSubscriberPermissionsEnvelope): CheckSubscriberPermissionsResponse | Promise<CheckSubscriberPermissionsResponse>;
+
+export { CheckSubscriberPermissionsEnvelope, CheckSubscriberPermissionsResponse, checkSubscriberPermissions };

package/build/es/index.typings.mjs

@@ -0,0 +1,40 @@
+// src/service-plugins-error-classes.ts
+var InvalidArgumentWixError = class extends Error {
+  constructor() {
+    super("InvalidArgumentError");
+    this.httpCode = 400;
+    this.statusCode = "INVALID_ARGUMENT";
+    this.applicationCode = "INVALID_ARGUMENT";
+    this.name = "InvalidArgumentError";
+    this.errorType = "SPI";
+    this.spiErrorData = {
+      name: "InvalidArgumentError",
+      applicationCode: "INVALID_ARGUMENT"
+    };
+  }
+};
+/** @hidden */
+InvalidArgumentWixError.__type = "wix_spi_error";
+
+// src/service-plugins-types.ts
+var SubscriberType = /* @__PURE__ */ ((SubscriberType2) => {
+  SubscriberType2["SUBSCRIBER_TYPE_UNSPECIFIED"] = "SUBSCRIBER_TYPE_UNSPECIFIED";
+  SubscriberType2["ADMIN"] = "ADMIN";
+  SubscriberType2["MEMBER"] = "MEMBER";
+  SubscriberType2["VISITOR"] = "VISITOR";
+  return SubscriberType2;
+})(SubscriberType || {});
+var IdentityType = /* @__PURE__ */ ((IdentityType2) => {
+  IdentityType2["UNKNOWN"] = "UNKNOWN";
+  IdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+  IdentityType2["MEMBER"] = "MEMBER";
+  IdentityType2["WIX_USER"] = "WIX_USER";
+  IdentityType2["APP"] = "APP";
+  return IdentityType2;
+})(IdentityType || {});
+export {
+  IdentityType,
+  InvalidArgumentWixError,
+  SubscriberType
+};
+//# sourceMappingURL=index.typings.mjs.map