npm - @wix/portfolio - Versions diffs - 1.0.48 → 1.0.50 - Mend

@wix/portfolio 1.0.48 → 1.0.50

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (169) hide show

package/build/es/src/portfolio-collections-v1-collection.types.d.ts DELETED Viewed

@@ -1,578 +0,0 @@
-/** Collection is the main entity of CollectionsService */
-export interface Collection {
-    /**
-     * Collection ID
-     * @readonly
-     */
-    id?: string | null;
-    /**
-     * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision
-     * @readonly
-     */
-    revision?: string | null;
-    title?: string | null;
-    description?: string | null;
-    /** Url of Collection */
-    slug?: string | null;
-    /** Collection's cover photo */
-    coverImage?: CommonImage;
-    /** Indicates if the collection is hidden from Portfolio */
-    hidden?: boolean | null;
-    /** if not present in an update it means the collection will be added as currentTimestamp - as the last collection */
-    sortOrder?: number | null;
-    /**
-     * Represents the time this Collection was created
-     * @readonly
-     */
-    createdDate?: Date;
-    /**
-     * Represents the time this Collection was last updated
-     * @readonly
-     */
-    updatedDate?: Date;
-    /**
-     * Url and relative url of Collection - in order to receive this field in READ requests you will need to pass the `include_page_url` field as part of request
-     * @readonly
-     */
-    url?: PageUrlV2;
-    seoData?: SeoSchema;
-}
-export interface CommonImage {
-    /** Image info - Wix Media Image. */
-    imageInfo?: Image;
-    /** Focal point of the image. */
-    focalPoint?: CommonPoint;
-}
-export declare enum ImageImageType {
-    UNDEFINED = "UNDEFINED",
-    WIX_MEDIA = "WIX_MEDIA",
-    EXTERNAL = "EXTERNAL"
-}
-export interface Image {
-    /** WixMedia image ID. Required. */
-    id?: string;
-    /**
-     * Image URL.
-     * @readonly
-     */
-    url?: string;
-    /** Original image height. Required. */
-    height?: number;
-    /** Original image width. Required. */
-    width?: number;
-    /** Image alt text. */
-    altText?: string | null;
-    /** Image filename. */
-    filename?: string | null;
-}
-export interface CommonPoint {
-    /** X-coordinate of the focal point. */
-    x?: number;
-    /** Y-coordinate of the focal point. */
-    y?: number;
-}
-export interface CommonUnsharpMasking {
-    /**
-     * Unsharp masking amount. Controls the sharpening strength. <br />
-     *
-     * Min: `0` <br />
-     * Max: `5`
-     */
-    amount?: number | null;
-    /** Unsharp masking radius in pixels. Controls the sharpening width. */
-    radius?: number | null;
-    /**
-     * Unsharp masking threshold. Controls how different neighboring pixels must be for shapening to apply. <br />
-     *
-     * Min: `0` <br />
-     * Max: `1`
-     */
-    threshold?: number | null;
-}
-export interface PageUrlV2 {
-    /** The relative path for the page within the site. For example, `/product-page/a-product`. */
-    relativePath?: string;
-    /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
-    url?: string | null;
-}
-/**
- * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
- * The search engines use this information for ranking purposes, or to display snippets in the search results.
- * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
- */
-export interface SeoSchema {
-    /** SEO tag information. */
-    tags?: Tag[];
-    /** SEO general settings. */
-    settings?: Settings;
-}
-export interface Keyword {
-    /** Keyword value. */
-    term?: string;
-    /** Whether the keyword is the main focus keyword. */
-    isMain?: boolean;
-}
-export interface Tag {
-    /**
-     * SEO tag type.
-     *
-     *
-     * Supported values: `title`, `meta`, `script`, `link`.
-     */
-    type?: string;
-    /**
-     * A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.
-     * For example: `{'name': 'description', 'content': 'the description itself'}`.
-     */
-    props?: Record<string, any> | null;
-    /** SEO tag meta data. For example, `{height: 300, width: 240}`. */
-    meta?: Record<string, any> | null;
-    /** SEO tag inner content. For example, `<title> inner content </title>`. */
-    children?: string;
-    /** Whether the tag is a custom tag. */
-    custom?: boolean;
-    /** Whether the tag is disabled. */
-    disabled?: boolean;
-}
-export interface Settings {
-    /**
-     * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
-     *
-     *
-     * Default: `false` (Auto Redirect is enabled.)
-     */
-    preventAutoRedirect?: boolean;
-    /** User-selected keyword terms for a specific page. */
-    keywords?: Keyword[];
-}
-export interface DomainEvent extends DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-    /**
-     * 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;
-}
-/** @oneof */
-export interface DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-}
-export interface EntityCreatedEvent {
-    entityAsJson?: string;
-}
-export interface EntityUpdatedEvent {
-    /**
-     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
-     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
-     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
-     */
-    currentEntityAsJson?: string;
-}
-export interface EntityDeletedEvent {
-    /** Entity that was deleted */
-    deletedEntityAsJson?: string | null;
-}
-export interface ActionEvent {
-    bodyAsJson?: string;
-}
-export interface Empty {
-}
-export interface AdminRemoveMenuItemsResponse {
-    /** number of items queried for deletion */
-    numItems?: number;
-    /** number of items sucessfully deleted */
-    numItemsSuccessfullyDeleted?: number;
-}
-export interface InvalidateCache extends InvalidateCacheGetByOneOf {
-    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
-    metaSiteId?: string;
-    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
-    siteId?: string;
-    /** Invalidate by App */
-    app?: App;
-    /** Invalidate by page id */
-    page?: Page;
-    /** Invalidate by URI path */
-    uri?: URI;
-    /** tell us why you're invalidating the cache. You don't need to add your app name */
-    reason?: string | null;
-    /** Is local DS */
-    localDc?: boolean;
-}
-/** @oneof */
-export interface InvalidateCacheGetByOneOf {
-    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
-    metaSiteId?: string;
-    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
-    siteId?: string;
-    /** Invalidate by App */
-    app?: App;
-    /** Invalidate by page id */
-    page?: Page;
-    /** Invalidate by URI path */
-    uri?: URI;
-}
-export interface App {
-    /** The AppDefId */
-    appDefId?: string;
-    /** The instance Id */
-    instanceId?: string;
-}
-export interface Page {
-    /** the msid the page is on */
-    metaSiteId?: string;
-    /** Invalidate by Page ID */
-    pageId?: string;
-}
-export interface URI {
-    /** the msid the URI is on */
-    metaSiteId?: string;
-    /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
-    uriPath?: string;
-}
-export interface CreateCollectionRequest {
-    /** Collection to be created */
-    collection: Collection;
-}
-export interface CreateCollectionResponse {
-    /** The created Collection */
-    collection?: Collection;
-}
-export interface GetCollectionRequest {
-    /** Id of the Collection to retrieve */
-    collectionId: string;
-    includePageUrl?: boolean | null;
-}
-export interface GetCollectionResponse {
-    /** The retrieved Collection */
-    collection?: Collection;
-}
-export interface ListCollectionsRequest {
-    /** Maximum limit per response is 100, in first request cursor is None */
-    paging?: CursorPaging;
-    includePageUrl?: boolean | null;
-}
-export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
-    limit?: number | null;
-    /**
-     * Pointer to the next or previous page in the list of results.
-     *
-     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
-     * Not relevant for the first request.
-     */
-    cursor?: string | null;
-}
-export interface ListCollectionsResponse {
-    /** Retrieved Collections */
-    collections?: Collection[];
-    /** Paging metadata */
-    metadata?: PagingMetadataV2;
-}
-export interface PagingMetadataV2 {
-    /** 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. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
-    total?: number | null;
-    /** Flag that indicates the server failed to calculate the `total` field. */
-    tooManyToCount?: boolean | null;
-    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
-    cursors?: Cursors;
-}
-export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
-    next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
-    prev?: string | null;
-}
-export interface UpdateCollectionRequest {
-    /** Collection to be updated, may be partial */
-    collection: Collection;
-}
-export interface UpdateCollectionResponse {
-    /** The updated Collection */
-    collection?: Collection;
-}
-export interface DeleteCollectionRequest {
-    /** Id of the Collection to delete */
-    collectionId: string;
-}
-export interface DeleteCollectionResponse {
-    /** Id of the Deleted Collection */
-    collectionId?: string;
-}
-export interface QueryCollectionsRequest {
-    /** WQL expression */
-    query: QueryV2;
-    includePageUrl?: boolean | null;
-}
-export interface QueryV2 extends QueryV2PagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging;
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
-    /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
-     */
-    filter?: Record<string, any> | null;
-    /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
-     */
-    sort?: Sorting[];
-    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
-    fields?: string[];
-    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
-    fieldsets?: string[];
-}
-/** @oneof */
-export interface QueryV2PagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging;
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
-}
-export interface Sorting {
-    /** Name of the field to sort by. */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrder;
-}
-export declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-export interface Paging {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-export interface QueryCollectionsResponse {
-    /** The retrieved Collections */
-    collections?: Collection[];
-    /** Paging metadata */
-    metadata?: PagingMetadataV2;
-}
-export interface CreateCollectionResponseNonNullableFields {
-    collection?: {
-        coverImage?: {
-            type: ImageImageType;
-            imageInfo?: {
-                id: string;
-                url: string;
-                height: number;
-                width: number;
-            };
-            focalPoint?: {
-                x: number;
-                y: number;
-            };
-        };
-        url?: {
-            relativePath: string;
-        };
-        seoData?: {
-            tags: {
-                type: string;
-                children: string;
-                custom: boolean;
-                disabled: boolean;
-            }[];
-            settings?: {
-                preventAutoRedirect: boolean;
-                keywords: {
-                    term: string;
-                    isMain: boolean;
-                }[];
-            };
-        };
-    };
-}
-export interface GetCollectionResponseNonNullableFields {
-    collection?: {
-        coverImage?: {
-            type: ImageImageType;
-            imageInfo?: {
-                id: string;
-                url: string;
-                height: number;
-                width: number;
-            };
-            focalPoint?: {
-                x: number;
-                y: number;
-            };
-        };
-        url?: {
-            relativePath: string;
-        };
-        seoData?: {
-            tags: {
-                type: string;
-                children: string;
-                custom: boolean;
-                disabled: boolean;
-            }[];
-            settings?: {
-                preventAutoRedirect: boolean;
-                keywords: {
-                    term: string;
-                    isMain: boolean;
-                }[];
-            };
-        };
-    };
-}
-export interface ListCollectionsResponseNonNullableFields {
-    collections: {
-        coverImage?: {
-            type: ImageImageType;
-            imageInfo?: {
-                id: string;
-                url: string;
-                height: number;
-                width: number;
-            };
-            focalPoint?: {
-                x: number;
-                y: number;
-            };
-        };
-        url?: {
-            relativePath: string;
-        };
-        seoData?: {
-            tags: {
-                type: string;
-                children: string;
-                custom: boolean;
-                disabled: boolean;
-            }[];
-            settings?: {
-                preventAutoRedirect: boolean;
-                keywords: {
-                    term: string;
-                    isMain: boolean;
-                }[];
-            };
-        };
-    }[];
-}
-export interface UpdateCollectionResponseNonNullableFields {
-    collection?: {
-        coverImage?: {
-            type: ImageImageType;
-            imageInfo?: {
-                id: string;
-                url: string;
-                height: number;
-                width: number;
-            };
-            focalPoint?: {
-                x: number;
-                y: number;
-            };
-        };
-        url?: {
-            relativePath: string;
-        };
-        seoData?: {
-            tags: {
-                type: string;
-                children: string;
-                custom: boolean;
-                disabled: boolean;
-            }[];
-            settings?: {
-                preventAutoRedirect: boolean;
-                keywords: {
-                    term: string;
-                    isMain: boolean;
-                }[];
-            };
-        };
-    };
-}
-export interface DeleteCollectionResponseNonNullableFields {
-    collectionId: string;
-}
-export interface QueryCollectionsResponseNonNullableFields {
-    collections: {
-        coverImage?: {
-            type: ImageImageType;
-            imageInfo?: {
-                id: string;
-                url: string;
-                height: number;
-                width: number;
-            };
-            focalPoint?: {
-                x: number;
-                y: number;
-            };
-        };
-        url?: {
-            relativePath: string;
-        };
-        seoData?: {
-            tags: {
-                type: string;
-                children: string;
-                custom: boolean;
-                disabled: boolean;
-            }[];
-            settings?: {
-                preventAutoRedirect: boolean;
-                keywords: {
-                    term: string;
-                    isMain: boolean;
-                }[];
-            };
-        };
-    }[];
-}

package/build/es/src/portfolio-collections-v1-collection.types.js DELETED Viewed

@@ -1,12 +0,0 @@
-export var ImageImageType;
-(function (ImageImageType) {
-    ImageImageType["UNDEFINED"] = "UNDEFINED";
-    ImageImageType["WIX_MEDIA"] = "WIX_MEDIA";
-    ImageImageType["EXTERNAL"] = "EXTERNAL";
-})(ImageImageType || (ImageImageType = {}));
-export var SortOrder;
-(function (SortOrder) {
-    SortOrder["ASC"] = "ASC";
-    SortOrder["DESC"] = "DESC";
-})(SortOrder || (SortOrder = {}));
-//# sourceMappingURL=portfolio-collections-v1-collection.types.js.map

package/build/es/src/portfolio-collections-v1-collection.types.js.map DELETED Viewed

@@ -1 +0,0 @@

- {"version":3,"file":"portfolio-collections-v1-collection.types.js","sourceRoot":"","sources":["../../../src/portfolio-collections-v1-collection.types.ts"],"names":[],"mappings":"AA+CA,MAAM,CAAN,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,yCAAuB,CAAA;IACvB,yCAAuB,CAAA;IACvB,uCAAqB,CAAA;AACvB,CAAC,EAJW,cAAc,KAAd,cAAc,QAIzB;AAqXD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB"}