@wix/auth-management 1.0.26 → 1.0.28

package/context/package.json

@@ -2,5 +2,6 @@
   "sideEffects": false,
   "module": "../build/es/context.js",
   "main": "../build/cjs/context.js",
-  "typings": "../build/cjs/context.d.ts"
+  "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/auth-management",
-  "version": "1.0.26",
+  "version": "1.0.28",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -9,21 +9,27 @@
   "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",
-    "context"
+    "context",
+    "type-bundles"
   ],
   "dependencies": {
-    "@wix/auth-management_o-auth-apps": "1.0.12"
+    "@wix/auth-management_o-auth-apps": "1.0.14"
   },
   "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": {
@@ -37,5 +43,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "c0ee39f6786a8aac14c7270f696c1ecb201caac06b2ba6dbe2ab29a5"
+  "falconPackageHash": "7ffa53cb1abc1d8840847ef00d8a105e303b38634e677570b97af67b"
 }

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

@@ -0,0 +1,293 @@
+/** An intermediary application that authorizes and authenticates an external client to access data on a Wix project or site. */
+interface OAuthApp {
+    /**
+     * ID of the OAuth app.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Date and time the OAuth app was created, in ISO 8601 format.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /** Display name of the OAuth app, as it appears in the dashboard. */
+    name?: string | null;
+    /** Description of the OAuth app, as it appears in the dashboard. */
+    description?: string | null;
+    /**
+     * For internal use only.
+     * @readonly
+     * @deprecated
+     */
+    secret?: string | null;
+    /** External login URL to which users are redirected automatically to authenticate. If no login URL is specified, the user is redirected to Wix to authenticate. */
+    loginUrl?: string | null;
+    /**
+     * List of URIs to which redirection from Wix is allowed after authentication.
+     *
+     * When a client redirects a user to Wix for authentication, the client provides a URI to redirect the user back to after the user has been authenticated.
+     * Wix only redirects the user if the exact URI is contained in this array.
+     */
+    allowedRedirectUris?: string[];
+    /**
+     * List of domains to which redirection from Wix is allowed after processes other than authentication.
+     *
+     * When a client redirects a user to a Wix page (for example, for checkout), the client provides a URL to redirect the user back to.
+     * Wix only redirects the user if the URL is in one of the specified domains.
+     */
+    allowedRedirectDomains?: string[];
+    /**
+     * Whether a secret can be generated for this OAuth app.
+     *
+     * Default: `true` until a secret has been generated for the OAuth App.
+     */
+    allowSecretGeneration?: boolean | null;
+    /** External logout URL to which we invoke when user logout at wix. If no logout URL is specified, the user is logged out only at Wix. */
+    logoutUrl?: string | null;
+}
+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 BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+interface OAuthAppCreatedEnvelope {
+    entity: OAuthApp;
+    metadata: EventMetadata;
+}
+interface OAuthAppUpdatedEnvelope {
+    entity: OAuthApp;
+    metadata: EventMetadata;
+}
+interface OAuthAppDeletedEnvelope {
+    metadata: EventMetadata;
+}
+interface UpdateOAuthApp {
+    /**
+     * ID of the OAuth app.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Date and time the OAuth app was created, in ISO 8601 format.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /** Display name of the OAuth app, as it appears in the dashboard. */
+    name?: string | null;
+    /** Description of the OAuth app, as it appears in the dashboard. */
+    description?: string | null;
+    /**
+     * For internal use only.
+     * @readonly
+     * @deprecated
+     */
+    secret?: string | null;
+    /** External login URL to which users are redirected automatically to authenticate. If no login URL is specified, the user is redirected to Wix to authenticate. */
+    loginUrl?: string | null;
+    /**
+     * List of URIs to which redirection from Wix is allowed after authentication.
+     *
+     * When a client redirects a user to Wix for authentication, the client provides a URI to redirect the user back to after the user has been authenticated.
+     * Wix only redirects the user if the exact URI is contained in this array.
+     */
+    allowedRedirectUris?: string[];
+    /**
+     * List of domains to which redirection from Wix is allowed after processes other than authentication.
+     *
+     * When a client redirects a user to a Wix page (for example, for checkout), the client provides a URL to redirect the user back to.
+     * Wix only redirects the user if the URL is in one of the specified domains.
+     */
+    allowedRedirectDomains?: string[];
+    /**
+     * Whether a secret can be generated for this OAuth app.
+     *
+     * Default: `true` until a secret has been generated for the OAuth App.
+     */
+    allowSecretGeneration?: boolean | null;
+    /** External logout URL to which we invoke when user logout at wix. If no logout URL is specified, the user is logged out only at Wix. */
+    logoutUrl?: string | null;
+}
+interface QueryOffsetResult {
+    currentPage: number | undefined;
+    totalPages: number | undefined;
+    totalCount: number | undefined;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface OAuthAppsQueryResult extends QueryOffsetResult {
+    items: OAuthApp[];
+    query: OAuthAppsQueryBuilder;
+    next: () => Promise<OAuthAppsQueryResult>;
+    prev: () => Promise<OAuthAppsQueryResult>;
+}
+interface OAuthAppsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id', value: any) => OAuthAppsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_createdDate' | 'name'>) => OAuthAppsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_createdDate' | 'name'>) => OAuthAppsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => OAuthAppsQueryBuilder;
+    /** @param skip - Number of items to skip in the query results before returning the results.
+     * @documentationMaturity preview
+     */
+    skip: (skip: number) => OAuthAppsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<OAuthAppsQueryResult>;
+}
+
+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 createOAuthApp$1(httpClient: HttpClient): (oAuthApp: OAuthApp) => Promise<OAuthApp & {
+    allowedRedirectUris: string[];
+    allowedRedirectDomains: string[];
+}>;
+declare function getOAuthApp$1(httpClient: HttpClient): (oAuthAppId: string) => Promise<OAuthApp & {
+    allowedRedirectUris: string[];
+    allowedRedirectDomains: string[];
+}>;
+declare function updateOAuthApp$1(httpClient: HttpClient): (_id: string | null, oAuthApp: UpdateOAuthApp) => Promise<OAuthApp & {
+    allowedRedirectUris: string[];
+    allowedRedirectDomains: string[];
+}>;
+declare function queryOAuthApps$1(httpClient: HttpClient): () => OAuthAppsQueryBuilder;
+declare const onOAuthAppCreated$1: EventDefinition<OAuthAppCreatedEnvelope, "wix.headless.v1.o_auth_app_created">;
+declare const onOAuthAppUpdated$1: EventDefinition<OAuthAppUpdatedEnvelope, "wix.headless.v1.o_auth_app_updated">;
+declare const onOAuthAppDeleted$1: EventDefinition<OAuthAppDeletedEnvelope, "wix.headless.v1.o_auth_app_deleted">;
+
+declare const createOAuthApp: BuildRESTFunction<typeof createOAuthApp$1>;
+declare const getOAuthApp: BuildRESTFunction<typeof getOAuthApp$1>;
+declare const updateOAuthApp: BuildRESTFunction<typeof updateOAuthApp$1>;
+declare const queryOAuthApps: BuildRESTFunction<typeof queryOAuthApps$1>;
+declare const onOAuthAppCreated: BuildEventDefinition<typeof onOAuthAppCreated$1>;
+declare const onOAuthAppUpdated: BuildEventDefinition<typeof onOAuthAppUpdated$1>;
+declare const onOAuthAppDeleted: BuildEventDefinition<typeof onOAuthAppDeleted$1>;
+
+declare const context_createOAuthApp: typeof createOAuthApp;
+declare const context_getOAuthApp: typeof getOAuthApp;
+declare const context_onOAuthAppCreated: typeof onOAuthAppCreated;
+declare const context_onOAuthAppDeleted: typeof onOAuthAppDeleted;
+declare const context_onOAuthAppUpdated: typeof onOAuthAppUpdated;
+declare const context_queryOAuthApps: typeof queryOAuthApps;
+declare const context_updateOAuthApp: typeof updateOAuthApp;
+declare namespace context {
+  export { context_createOAuthApp as createOAuthApp, context_getOAuthApp as getOAuthApp, context_onOAuthAppCreated as onOAuthAppCreated, context_onOAuthAppDeleted as onOAuthAppDeleted, context_onOAuthAppUpdated as onOAuthAppUpdated, context_queryOAuthApps as queryOAuthApps, context_updateOAuthApp as updateOAuthApp };
+}
+
+export { context as oAuthApps };