@wix/email-subscriptions 1.0.13 → 1.0.16

package/build/cjs/context.d.ts

@@ -0,0 +1 @@
+export * as emailSubscriptions from '@wix/email-subscriptions_email-subscriptions/context';

package/build/cjs/{index.typings.js → context.js}

@@ -24,5 +24,5 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.emailSubscriptions = void 0;
-exports.emailSubscriptions = __importStar(require("./src/emailsubscriptions-v1-emailsubscription.universal"));
-//# sourceMappingURL=index.typings.js.map
+exports.emailSubscriptions = __importStar(require("@wix/email-subscriptions_email-subscriptions/context"));
+//# sourceMappingURL=context.js.map

package/build/cjs/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../context.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2GAA2F"}

package/build/cjs/index.d.ts

@@ -1 +1 @@
-export * as emailSubscriptions from './src/emailsubscriptions-v1-emailsubscription.public';
+export * as emailSubscriptions from '@wix/email-subscriptions_email-subscriptions';

package/build/cjs/index.js

@@ -24,5 +24,5 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.emailSubscriptions = void 0;
-exports.emailSubscriptions = __importStar(require("./src/emailsubscriptions-v1-emailsubscription.public"));
+exports.emailSubscriptions = __importStar(require("@wix/email-subscriptions_email-subscriptions"));
 //# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2GAA2F"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mGAAmF"}

package/build/cjs/meta.d.ts

@@ -1 +1 @@
-export * as emailSubscriptions from './src/emailsubscriptions-v1-emailsubscription.meta';
+export * as emailSubscriptions from '@wix/email-subscriptions_email-subscriptions/meta';

package/build/cjs/meta.js

@@ -24,5 +24,5 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.emailSubscriptions = void 0;
-exports.emailSubscriptions = __importStar(require("./src/emailsubscriptions-v1-emailsubscription.meta"));
+exports.emailSubscriptions = __importStar(require("@wix/email-subscriptions_email-subscriptions/meta"));
 //# sourceMappingURL=meta.js.map

package/build/cjs/meta.js.map

@@ -1 +1 @@
-{"version":3,"file":"meta.js","sourceRoot":"","sources":["../../meta.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yGAAyF"}
+{"version":3,"file":"meta.js","sourceRoot":"","sources":["../../meta.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,wGAAwF"}

package/build/es/context.d.ts

@@ -0,0 +1 @@
+export * as emailSubscriptions from '@wix/email-subscriptions_email-subscriptions/context';

package/build/es/context.js

@@ -0,0 +1,2 @@
+export * as emailSubscriptions from '@wix/email-subscriptions_email-subscriptions/context';
+//# sourceMappingURL=context.js.map

package/build/es/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,kBAAkB,MAAM,sDAAsD,CAAC"}

package/build/es/index.d.ts

@@ -1 +1 @@
-export * as emailSubscriptions from './src/emailsubscriptions-v1-emailsubscription.public';
+export * as emailSubscriptions from '@wix/email-subscriptions_email-subscriptions';

package/build/es/index.js

@@ -1,2 +1,2 @@
-export * as emailSubscriptions from './src/emailsubscriptions-v1-emailsubscription.public';
+export * as emailSubscriptions from '@wix/email-subscriptions_email-subscriptions';
 //# sourceMappingURL=index.js.map

package/build/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,kBAAkB,MAAM,sDAAsD,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,kBAAkB,MAAM,8CAA8C,CAAC"}

package/build/es/meta.d.ts

@@ -1 +1 @@
-export * as emailSubscriptions from './src/emailsubscriptions-v1-emailsubscription.meta';
+export * as emailSubscriptions from '@wix/email-subscriptions_email-subscriptions/meta';

package/build/es/meta.js

@@ -1,2 +1,2 @@
-export * as emailSubscriptions from './src/emailsubscriptions-v1-emailsubscription.meta';
+export * as emailSubscriptions from '@wix/email-subscriptions_email-subscriptions/meta';
 //# sourceMappingURL=meta.js.map

package/build/es/meta.js.map

@@ -1 +1 @@
-{"version":3,"file":"meta.js","sourceRoot":"","sources":["../../meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,kBAAkB,MAAM,oDAAoD,CAAC"}
+{"version":3,"file":"meta.js","sourceRoot":"","sources":["../../meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,kBAAkB,MAAM,mDAAmD,CAAC"}

package/context/package.json

@@ -0,0 +1,7 @@
+{
+  "sideEffects": false,
+  "module": "../build/es/context.js",
+  "main": "../build/cjs/context.js",
+  "typings": "../build/cjs/context.d.ts",
+  "typesBundle": "../type-bundles/context.bundle.d.ts"
+}

package/meta/package.json

@@ -2,5 +2,6 @@
   "sideEffects": false,
   "module": "../build/es/meta.js",
   "main": "../build/cjs/meta.js",
-  "typings": "../build/cjs/meta.d.ts"
+  "typings": "../build/cjs/meta.d.ts",
+  "typesBundle": "../type-bundles/meta.bundle.d.ts"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/email-subscriptions",
-  "version": "1.0.13",
+  "version": "1.0.16",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -9,29 +9,39 @@
   "module": "build/es/index.js",
   "main": "build/cjs/index.js",
   "typings": "./build/cjs/index.d.ts",
+  "typesBundle": "./type-bundles/index.bundle.d.ts",
   "files": [
     "build",
     "frontend/package.json",
-    "meta"
+    "meta",
+    "context",
+    "type-bundles"
   ],
   "dependencies": {
-    "@wix/metro-runtime": "^1.1528.0",
-    "@wix/sdk-types": "^1.5.3",
-    "@wix/sdk-runtime": "^0.2.7",
-    "@wix/motion-edm-autogen-query-wrapper": "^1.0.37"
+    "@wix/email-subscriptions_email-subscriptions": "1.0.2"
   },
   "devDependencies": {
+    "@wix/sdk": "https://cdn.dev.wixpress.com/@wix/sdk/02e8069ab2fd783e0e6a080fc7d590e76cb26ab93c8389574286305b.tar.gz",
+    "glob": "^10.4.1",
+    "rollup": "^4.18.0",
+    "rollup-plugin-dts": "^6.1.1",
     "typescript": "^5.3.2"
   },
   "scripts": {
-    "build": "tsc -b tsconfig.json tsconfig.esm.json",
+    "build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles",
+    "build:dts-bundles": "test -f config/rollup-config.js && rollup --config config/rollup-config.js || echo 'Warning: config/rollup-config.js not found!'",
     "test": ":"
   },
   "wix": {
     "artifact": {
+      "groupId": "com.wixpress.public-sdk-autogen",
       "artifactId": "email-subscriptions-public-sdk-autogen",
-      "groupId": "com.wixpress.public-sdk-autogen"
+      "isRootPublicSdk": true
+    },
+    "sdkDependency": {
+      "fqdnNamespace": "",
+      "fqdn": ""
     }
   },
-  "falconPackageHash": "702cf2aa90173ea4685101c94466829c2492135f2325c81edb437402"
+  "falconPackageHash": "70480b3bd092f8a9a416e0edb528f2835102f8566cd057214bdf8e05"
 }

package/type-bundles/context.bundle.d.ts

@@ -0,0 +1,283 @@
+interface EmailSubscription {
+    /**
+     * Email subscription ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /** Email address. */
+    email?: string;
+    /**
+     * Indicates the recipient's opt-in or opt-out status
+     * for marketing emails.
+     *
+     * - `NOT_SET`: No status specified. This is the default, initial value before any info about the email address is known.
+     * - `PENDING`: Subscription confirmation was requested,
+     * but recipient hasn't confirmed yet.
+     * - `SUBSCRIBED`: Recipient has opted in to marketing emails.
+     * - `UNSUBSCRIBED`: Recipient has opted out of marketing emails.
+     *
+     * Defaults to `NOT_SET`.
+     */
+    subscriptionStatus?: SubscriptionEnumStatus;
+    /**
+     * Indicates last reported status of sent emails.
+     *
+     * - `NOT_SET`: No status specified. This is the default, initial value before any info about the email address is known.
+     * - `VALID`: Emails to this email address are being delivered successfully.
+     * - `BOUNCED`: The last email to the recipient bounced or was rejected.
+     * - `SPAM_COMPLAINT`: The recipient registered a spam complaint
+     * with their email provider.
+     * - `INACTIVE`: Multiple campaigns have been delivered to this address without any engagement from the recipient. (No emails were opened and no content was clicked.)
+     * This status might impact subsequent emails sent to this address.
+     *
+     * Defaults to `NOT_SET`.
+     */
+    deliverabilityStatus?: Status;
+    /**
+     * Date and time the email subscription was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date and time the email subscription was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+}
+declare enum SubscriptionEnumStatus {
+    UNKNOWN = "UNKNOWN",
+    /** No Subscription exists */
+    NOT_SET = "NOT_SET",
+    /** Pending Subscription */
+    PENDING = "PENDING",
+    /** Subscribed */
+    SUBSCRIBED = "SUBSCRIBED",
+    /** UnSubscribed */
+    UNSUBSCRIBED = "UNSUBSCRIBED"
+}
+declare enum Status {
+    NOT_SET = "NOT_SET",
+    /** valid/deferral */
+    VALID = "VALID",
+    /** bounced/rejected/invalid */
+    BOUNCED = "BOUNCED",
+    /** spam/complaint */
+    SPAM_COMPLAINT = "SPAM_COMPLAINT",
+    /** valid, but no activity reported */
+    INACTIVE = "INACTIVE"
+}
+interface EmailSubscriptionChanged {
+    /** subscription */
+    subscription?: EmailSubscription;
+}
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface QueryEmailSubscriptionsResponse {
+    /** List of subscribed emails that matched the query options. */
+    subscriptions?: EmailSubscription[];
+    /** Metadata for the paginated results. */
+    metadata?: PagingMetadata;
+}
+interface PagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+}
+interface UpsertEmailSubscriptionResponse {
+    /** Updated or created email subscription. */
+    subscription?: EmailSubscription;
+}
+interface BulkUpsertEmailSubscriptionResponse {
+    /** List of updated or created email subscriptions. */
+    results?: BulkUpsertEmailSubscriptionResult[];
+    /** Numbers of successful and failed actions. */
+    metadata?: Metadata;
+}
+interface BulkUpsertEmailSubscriptionResult {
+    /** Position of the requested email subscription in the bulk array. */
+    originalIndex?: number;
+    /** New or updated email subscription. */
+    emailSubscription?: EmailSubscription;
+    /**
+     * Error information if the action failed.
+     * Omitted from successful actions.
+     */
+    error?: Error;
+}
+interface Error {
+    /** Error code. */
+    errorCode?: string;
+    /** Message that contains details about the error. */
+    message?: string;
+}
+interface Metadata {
+    /** Number of successful actions. */
+    totalSuccess?: number;
+    /** Number of failed actions. */
+    totalFailure?: number;
+}
+interface GenerateUnsubscribeLinkResponse {
+    /** The unsubscribe link. */
+    link?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface QueryEmailSubscriptionsResponseNonNullableFields {
+    subscriptions: {
+        email: string;
+        subscriptionStatus: SubscriptionEnumStatus;
+        deliverabilityStatus: Status;
+    }[];
+}
+interface UpsertEmailSubscriptionResponseNonNullableFields {
+    subscription?: {
+        email: string;
+        subscriptionStatus: SubscriptionEnumStatus;
+        deliverabilityStatus: Status;
+    };
+}
+interface BulkUpsertEmailSubscriptionResponseNonNullableFields {
+    results: {
+        originalIndex: number;
+        emailSubscription?: {
+            email: string;
+            subscriptionStatus: SubscriptionEnumStatus;
+            deliverabilityStatus: Status;
+        };
+        error?: {
+            errorCode: string;
+            message: string;
+        };
+    }[];
+    metadata?: {
+        totalSuccess: number;
+        totalFailure: number;
+    };
+}
+interface GenerateUnsubscribeLinkResponseNonNullableFields {
+    link: string;
+}
+interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EmailsubscriptionEmailSubscriptionChangedEnvelope {
+    data: EmailSubscriptionChanged;
+    metadata: BaseEventMetadata;
+}
+interface QueryEmailSubscriptionsOptions {
+    /**
+     * Pagination options. For more information, see
+     * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
+     */
+    paging?: Paging;
+}
+interface UpsertEmailSubscriptionOptions {
+    /** Email subscription to update or create. */
+    subscription?: EmailSubscription;
+}
+interface GenerateUnsubscribeLinkOptions {
+    /** Arbitrary parameters for closing-the-loop. */
+    metadata?: Record<string, string>;
+    /** Language for displaying unsubscribe confirmation page (optional - default EN). */
+    language?: string | null;
+}
+
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: unknown;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+declare function queryEmailSubscriptions$1(httpClient: HttpClient): (filter: Record<string, any> | null, options?: QueryEmailSubscriptionsOptions) => Promise<QueryEmailSubscriptionsResponse & QueryEmailSubscriptionsResponseNonNullableFields>;
+declare function upsertEmailSubscription$1(httpClient: HttpClient): (options?: UpsertEmailSubscriptionOptions) => Promise<UpsertEmailSubscriptionResponse & UpsertEmailSubscriptionResponseNonNullableFields>;
+declare function bulkUpsertEmailSubscription$1(httpClient: HttpClient): (subscriptions: EmailSubscription[]) => Promise<BulkUpsertEmailSubscriptionResponse & BulkUpsertEmailSubscriptionResponseNonNullableFields>;
+declare function generateUnsubscribeLink$1(httpClient: HttpClient): (emailAddress: string, options?: GenerateUnsubscribeLinkOptions) => Promise<GenerateUnsubscribeLinkResponse & GenerateUnsubscribeLinkResponseNonNullableFields>;
+declare const onEmailsubscriptionEmailSubscriptionChanged$1: EventDefinition<EmailsubscriptionEmailSubscriptionChangedEnvelope, "com.wixpress.emailsubscriptions.v1.EmailSubscriptionChanged">;
+
+declare const queryEmailSubscriptions: BuildRESTFunction<typeof queryEmailSubscriptions$1>;
+declare const upsertEmailSubscription: BuildRESTFunction<typeof upsertEmailSubscription$1>;
+declare const bulkUpsertEmailSubscription: BuildRESTFunction<typeof bulkUpsertEmailSubscription$1>;
+declare const generateUnsubscribeLink: BuildRESTFunction<typeof generateUnsubscribeLink$1>;
+declare const onEmailsubscriptionEmailSubscriptionChanged: BuildEventDefinition<typeof onEmailsubscriptionEmailSubscriptionChanged$1>;
+
+declare const context_bulkUpsertEmailSubscription: typeof bulkUpsertEmailSubscription;
+declare const context_generateUnsubscribeLink: typeof generateUnsubscribeLink;
+declare const context_onEmailsubscriptionEmailSubscriptionChanged: typeof onEmailsubscriptionEmailSubscriptionChanged;
+declare const context_queryEmailSubscriptions: typeof queryEmailSubscriptions;
+declare const context_upsertEmailSubscription: typeof upsertEmailSubscription;
+declare namespace context {
+  export { context_bulkUpsertEmailSubscription as bulkUpsertEmailSubscription, context_generateUnsubscribeLink as generateUnsubscribeLink, context_onEmailsubscriptionEmailSubscriptionChanged as onEmailsubscriptionEmailSubscriptionChanged, context_queryEmailSubscriptions as queryEmailSubscriptions, context_upsertEmailSubscription as upsertEmailSubscription };
+}
+
+export { context as emailSubscriptions };