@rezamirzapour/pod-sdk 1.0.3 → 1.0.5

package/dist/index.d.mts

@@ -43,18 +43,27 @@ interface SendOtpOptions {
 interface PodUrlsConfig {
     accounts?: string;
     apiPod?: string;
+    apiPodSandbox?: string;
     cms?: string;
+    iums?: string;
+    notification?: string;
+    podreport?: string;
     podspace?: string;
     podform?: string;
-    notification?: string;
-    iums?: string;
+    sandboxCms?: string;
+    sandboxCmsClient?: string;
+    sandboxPodspace?: string;
+    sandboxStream?: string;
+    stream?: string;
     website?: string;
+    [key: string]: string | undefined;
 }
 interface PodSdkConfig {
     apiToken?: string;
     clientId?: string;
     clientSecret?: string;
     privateKeyPem?: string;
+    sandbox?: boolean;
     urls?: PodUrlsConfig;
     revalidate?: number | string;
     timeout?: number;
@@ -434,7 +443,7 @@ interface SendSmsResponse {
 }
 
 interface NotificationServiceOptions {
-    baseUrl: string;
+    baseUrl?: string;
     apiToken: string;
 }
 declare class NotificationService {
@@ -637,21 +646,50 @@ type MetaContent = {
     value: any;
     type: string;
 });
+interface TagTreeMetadata {
+    icon?: string;
+    related_contents?: {
+        id: number;
+    }[];
+    longDescription?: string;
+    description?: string;
+    content?: string;
+    link?: string;
+    target?: string;
+    preview?: string;
+    displayName?: string;
+    englishName?: string;
+    created?: any[];
+    updated?: any[];
+    published?: any[];
+    unpublished?: any[];
+    parentModifier?: any[];
+    codeModifier?: any[];
+    enabled?: any[];
+    disabled?: any[];
+    [key: string]: any;
+}
 interface TagtreesType {
     id: number;
     name: string;
     code: string;
     categoryName?: string;
     siblingOrder?: number;
-    metadata?: {
-        content?: string;
-        created?: any;
-        parentModifier?: any;
-        updated?: any;
-        displayName?: string;
-        englishName?: string;
+    level?: number;
+    parent?: number;
+    orderInSiblings?: number;
+    enable?: boolean;
+    creationDate?: number;
+    category?: {
+        id: number;
+        name: string;
+        businessSoftSrv?: any;
+        creationDate?: number;
+        enable?: boolean;
         [key: string]: any;
     };
+    metadata?: TagTreeMetadata;
+    [key: string]: any;
 }
 interface CmsMetadata {
     content_type_id?: string;
@@ -1032,6 +1070,111 @@ interface CmsRequestOptions<TSubject = any> {
     headers?: HeadersInit;
     signal?: AbortSignal;
 }
+interface TagCategoryItem {
+    id: number;
+    name: string;
+    businessSoftSrv?: any;
+    creationDate?: string;
+    enable?: boolean;
+    desc?: string;
+    [key: string]: any;
+}
+interface TagCategoryListParams {
+    offset?: number;
+    size?: number;
+    id?: number | string;
+    name?: string;
+    query?: string;
+    [key: string]: any;
+}
+interface CreateTagCategoryParams {
+    name: string;
+    desc?: string;
+    [key: string]: any;
+}
+interface UpdateTagCategoryParams {
+    name: string;
+    desc?: string;
+    enable?: boolean;
+    [key: string]: any;
+}
+interface GetTagCategoriesResponse {
+    referenceNumber?: string;
+    hasError: boolean;
+    errorCode?: number;
+    refId?: string;
+    message?: string | any[];
+    count?: number;
+    aggregations?: number;
+    result: TagCategoryItem[];
+    [key: string]: any;
+}
+interface GetTagTreeParams {
+    parentId?: number | string;
+    id?: string | number;
+    parentCode?: string;
+    includeParent?: boolean;
+    excludeTree?: boolean;
+    levelCount?: number;
+    level?: number;
+    name?: string;
+    size?: number;
+    offset?: number;
+    siblingOrder?: string;
+    enable?: boolean;
+    [key: string]: any;
+}
+interface CreateTagTreeItemParams {
+    name: string;
+    parentId?: number | string;
+    code?: string;
+    relatedContentIds?: number[];
+    icon?: string;
+    description?: string;
+    longDescription?: string;
+    link?: string;
+    target?: '_self' | '_blank' | '_parent' | '_top';
+    content?: string;
+    preview?: string;
+    siblingOrder?: number;
+    displayName?: string;
+    englishName?: string;
+    [key: string]: any;
+}
+interface UpdateTagTreeItemParams {
+    name?: string;
+    parentId?: number | string;
+    code?: string;
+    relatedContentIds?: number[];
+    icon?: string;
+    description?: string;
+    longDescription?: string;
+    link?: string;
+    target?: '_self' | '_blank' | '_parent' | '_top';
+    content?: string;
+    preview?: string;
+    siblingOrder?: number;
+    displayName?: string;
+    englishName?: string;
+    [key: string]: any;
+}
+interface TagTreeAncestorsParams {
+    levelCount?: number;
+    level?: number;
+    [key: string]: any;
+}
+interface GetTagTreeResponse {
+    referenceNumber?: string;
+    hasError: boolean;
+    errorCode?: number;
+    refId?: string;
+    message?: string | any[];
+    count?: number;
+    aggregations?: number;
+    result: TagtreesType[];
+    metadata?: any[];
+    [key: string]: any;
+}
 
 declare class CmsDataFormatter {
     private podspaceUrl;
@@ -1180,6 +1323,114 @@ declare class CmsProductService {
     timelineSearch(query?: TimelineSearchBody): Promise<TimelineResponse>;
 }
 
+interface CmsTagServiceOptions {
+    baseUrl?: string;
+    clientId: string;
+    apiToken?: string;
+    revalidate?: number | string;
+    http?: NextHttp;
+}
+declare class CmsTagService {
+    private http;
+    private clientId;
+    private apiToken;
+    private revalidate;
+    constructor(options: CmsTagServiceOptions);
+    private get commonHeaders();
+    private get managingHeaders();
+    /**
+     * Retrieves list of tag categories.
+     * Swagger: GET /api/core/tags/category
+     */
+    getTagCategories(params?: TagCategoryListParams, options?: CmsRequestOptions): Promise<GetTagCategoriesResponse>;
+    /**
+     * Creates a new tag category.
+     * Swagger: POST /api/core/tags/category
+     */
+    createTagCategory(params: CreateTagCategoryParams, options?: CmsRequestOptions): Promise<any>;
+    /**
+     * Retrieves single tag category by ID.
+     * Swagger: GET /api/core/tags/category/{id}
+     */
+    getTagCategory(id: number | string, options?: CmsRequestOptions): Promise<any>;
+    /**
+     * Updates an existing tag category.
+     * Swagger: PUT /api/core/tags/category/{id}
+     */
+    updateTagCategory(id: number | string, params: UpdateTagCategoryParams, options?: CmsRequestOptions): Promise<any>;
+    /**
+     * Publishes a tag category.
+     * Swagger: PUT /api/core/tags/category/{id}/publish
+     */
+    publishTagCategory(id: number | string, options?: CmsRequestOptions): Promise<any>;
+    /**
+     * Unpublishes a tag category.
+     * Swagger: PUT /api/core/tags/category/{id}/unpublish
+     */
+    unpublishTagCategory(id: number | string, options?: CmsRequestOptions): Promise<any>;
+    /**
+     * Retrieves enabled published tag tree for category (defaults to 'root').
+     * End user call (without requiring Access-Token).
+     * Swagger: GET /api/core/tags/{categoryId}/tree/enable
+     */
+    getTagTree(categoryId?: string | number, params?: GetTagTreeParams, options?: CmsRequestOptions): Promise<GetTagTreeResponse>;
+    /**
+     * Retrieves tag tree for category with management credentials.
+     * Swagger: GET /api/core/tags/{categoryId}/tree/manage
+     */
+    getManageTagTree(categoryId: string | number, params?: GetTagTreeParams, options?: CmsRequestOptions): Promise<GetTagTreeResponse>;
+    /**
+     * Creates a new tag tree node for category.
+     * Swagger: POST /api/core/tags/{categoryId}/tree
+     */
+    createTagTreeItem(categoryId: string | number, params: CreateTagTreeItemParams, options?: CmsRequestOptions): Promise<any>;
+    /**
+     * Shows a single enabled tag tree item for end users.
+     * Swagger: GET /api/core/tags/{categoryId}/tree/{id}/enable
+     */
+    getTagTreeItem(categoryId: string | number, id: number | string, options?: CmsRequestOptions): Promise<any>;
+    /**
+     * Shows a single tag tree item for manager (with token).
+     * Swagger: GET /api/core/tags/{categoryId}/tree/{id}/manage
+     */
+    getManageTagTreeItem(categoryId: string | number, id: number | string, options?: CmsRequestOptions): Promise<any>;
+    /**
+     * Updates an existing tag tree node.
+     * Swagger: PUT /api/core/tags/{categoryId}/tree/{id}
+     */
+    updateTagTreeItem(categoryId: string | number, id: number | string, params: UpdateTagTreeItemParams, options?: CmsRequestOptions): Promise<any>;
+    /**
+     * Publishes a tag tree item.
+     * Swagger: PUT /api/core/tags/{categoryId}/tree/publish/{id}
+     */
+    publishTagTreeItem(categoryId: string | number, id: number | string, options?: CmsRequestOptions): Promise<any>;
+    /**
+     * Unpublishes a tag tree item.
+     * Swagger: PUT /api/core/tags/{categoryId}/tree/unpublish/{id}
+     */
+    unpublishTagTreeItem(categoryId: string | number, id: number | string, options?: CmsRequestOptions): Promise<any>;
+    /**
+     * Updates the parent of a tag tree item.
+     * Swagger: PUT /api/core/tags/{categoryId}/tree/parent/{id}
+     */
+    updateTagTreeParent(categoryId: string | number, id: number | string, parentId?: number | string, options?: CmsRequestOptions): Promise<any>;
+    /**
+     * Retrieves tag tree ancestors for end user.
+     * Swagger: GET /api/core/tags/{categoryId}/tree/parent/{id}/enable
+     */
+    getTagTreeAncestors(categoryId: string | number, id: number | string, params?: TagTreeAncestorsParams, options?: CmsRequestOptions): Promise<GetTagTreeResponse>;
+    /**
+     * Retrieves tag tree ancestors for manager (with token).
+     * Swagger: GET /api/core/tags/{categoryId}/tree/parent/{id}/manage
+     */
+    getManageTagTreeAncestors(categoryId: string | number, id: number | string, params?: TagTreeAncestorsParams, options?: CmsRequestOptions): Promise<GetTagTreeResponse>;
+    /**
+     * Updates tag tree code for category.
+     * Swagger: PUT /api/core/tags/{categoryId}/tree/code/{id}
+     */
+    updateTagTreeCode(categoryId: string | number, id: number | string, code: string, options?: CmsRequestOptions): Promise<any>;
+}
+
 interface CmsServiceOptions {
     baseUrl: string;
     clientId: string;
@@ -1198,6 +1449,11 @@ declare class CmsService {
      * Swagger: tag=product
      */
     readonly products: CmsProductService;
+    /**
+     * Dedicated CMS Tags & Tag Categories sub-service.
+     * Swagger: tag=tags
+     */
+    readonly tags: CmsTagService;
     constructor(options: CmsServiceOptions);
     private get commonHeaders();
     private get managingHeaders();
@@ -1358,7 +1614,8 @@ declare class CmsService {
     getDislikes(contentUniqueId: string, entityId: number | string, params?: GetReactionsParams): Promise<any>;
     /**
      * Retrieves tag/category tree.
-     * Swagger: GET /api/core/tags/root/tree/enable
+     * Backward-compatible delegate pointing to `cms.tags.getTagTree('root', params, options)`.
+     * Swagger: GET /api/core/tags/{categoryId}/tree/enable
      */
     getCategories(params?: GetCategoriesParams, options?: CmsRequestOptions): Promise<GetCategoryResponse>;
     /**
@@ -1401,12 +1658,13 @@ interface IumsResponse<T = any> {
 }
 
 interface IumsServiceOptions {
-    baseUrl: string;
+    baseUrl?: string;
     clientId: string;
     revalidate?: number | string;
 }
 declare class IumsService {
     private http;
+    private baseUrl;
     private clientId;
     private revalidate;
     constructor(options: IumsServiceOptions);
@@ -1429,8 +1687,10 @@ declare class PodSdk {
     readonly social: SocialService;
     readonly cms: CmsService;
     readonly product: CmsProductService;
+    readonly tags: CmsTagService;
     readonly iums: IumsService;
-    constructor(config: PodSdkConfig);
+    readonly urls: Required<PodUrlsConfig>;
+    constructor(config?: PodSdkConfig);
     /**
      * Helper shortcut to instantiate a Generic CRUD repository for any entity type on POD CustomPost.
      */
@@ -1441,6 +1701,38 @@ declare class PodSdk {
  */
 declare function createPodSdk(config: PodSdkConfig): PodSdk;
 
+/**
+ * Official POD Platform Production URLs.
+ */
+declare const DEFAULT_POD_URLS: Required<PodUrlsConfig>;
+/**
+ * Official POD Platform Sandbox URLs for development and testing.
+ */
+declare const SANDBOX_POD_URLS: Required<PodUrlsConfig>;
+/**
+ * Resolves full POD URL configuration with the following priority:
+ * 1. Explicit user overrides in `config.urls`
+ * 2. Next.js / Node environment variables (`process.env.NEXT_PUBLIC_*`)
+ * 3. Default production / sandbox URLs
+ *
+ * Supported Environment Variables:
+ * - `NEXT_PUBLIC_ACCOUNTS_URL`
+ * - `NEXT_PUBLIC_API_POD_URL`
+ * - `NEXT_PUBLIC_API_POD_SANDBOX_URL`
+ * - `NEXT_PUBLIC_CMS_URL`
+ * - `NEXT_PUBLIC_IUMS_URL`
+ * - `NEXT_PUBLIC_NOTIFICATION_URL`
+ * - `NEXT_PUBLIC_PODREPORT_URL`
+ * - `NEXT_PUBLIC_PODSPACE_URL`
+ * - `NEXT_PUBLIC_SANDBOX_CMS_URL`
+ * - `NEXT_PUBLIC_SANDBOX_CMS_CLIENT_URL`
+ * - `NEXT_PUBLIC_SANDBOX_PODSPACE_URL`
+ * - `NEXT_PUBLIC_SANDBOX_STREAM_URL`
+ * - `NEXT_PUBLIC_PODFORM_URL`
+ * - `NEXT_PUBLIC_WEBSITE_URL`
+ */
+declare function resolvePodUrls(urls?: PodUrlsConfig, sandbox?: boolean): Required<PodUrlsConfig>;
+
 /**
  * Cryptographic and encoding utilities for POD Platform services.
  * Uses standard Web Crypto API (supported natively in Node.js 18+, Browsers, and Edge).
@@ -1448,4 +1740,4 @@ declare function createPodSdk(config: PodSdkConfig): PodSdk;
 declare function encodeBase64(str: string): string;
 declare function generatePodSignatureHeader(keyId: string, privateKeyPem?: string): Promise<string>;
 
-export { type AddCommentParams, type AddContentParams, type AddCustomPostParams, type AddCustomPostResponse, type AddProductParams, type ArchiveParams, type ArchiveProductParams, type BatchPublishParams, type BatchPublishProductParams, type BatchUnpublishParams, type BatchUnpublishProductParams, type Business, CmsDataFormatter, type CmsMetadata, CmsProductService, type CmsProductServiceOptions, type CmsRequestOptions, CmsService, type CmsServiceOptions, type CommentItem, type ContentBody, type CustomPostCrudConfig, CustomPostCrudService, type CustomPostItem, CustomPostService, type CustomPostServiceOptions, type EditContentParams, type EditProductParams, type FormattedGetContentResponse, type FormattedGetProductResponse, type FormattedProductSubject, type FormattedSubject, type GetCategoriesParams, type GetCategoryResponse, type GetCommentListParams, type GetCommentsParams, type GetContentByEntityIdParams, type GetContentParams, type GetContentResponse, type GetCustomPostParams, type GetCustomPostResponse, type GetInfOfGraduatedByGraduateDateResponse, type GetProductByEntityIdParams, type GetProductParams, type GetProductResponse, type GetReactionsParams, type GetSessionClassInCurrentDayResponse, type HandshakeResponse, type IumsResponse, IumsService, type IumsServiceOptions, type LikeCommentParams, type LikePostParams, type MetaContent, type Metadata, NotificationService, type NotificationServiceOptions, type PodFormItem, type PodFormResponse, PodFormService, type PodFormServiceOptions, type PodResponse, PodSdk, type PodSdkConfig, type PodUrlsConfig, PodspaceService, type PodspaceServiceOptions, type PodspaceUploadResponse, type PodspaceUploadResult, type ProductBody, type ProductItem, type ProductItemWithFormatted, type Rate, type ResultItem, type ResultItemWithFormatted, type SearchTimelineByMetadataParam, type SearchTimelineParamMetaQuery, type SearchTimelineResponse, type SearchTimelineResultItem, type SendOtpOptions, type SendSmsParams, type SendSmsResponse, type SeoType, type SocialResponse, SocialService, type SocialServiceOptions, SsoService, type SsoServiceOptions, type SsoUserProfile, type Subject, type TagtreesType, type TimelineResponse, type TimelineSearchBody, type TokenResponse, type UpdateCustomPostParams, type UserPostInfo, type VerifyResponse, createPodSdk, PodSdk as default, encodeBase64, generatePodSignatureHeader };
+export { type AddCommentParams, type AddContentParams, type AddCustomPostParams, type AddCustomPostResponse, type AddProductParams, type ArchiveParams, type ArchiveProductParams, type BatchPublishParams, type BatchPublishProductParams, type BatchUnpublishParams, type BatchUnpublishProductParams, type Business, CmsDataFormatter, type CmsMetadata, CmsProductService, type CmsProductServiceOptions, type CmsRequestOptions, CmsService, type CmsServiceOptions, CmsTagService, type CmsTagServiceOptions, type CommentItem, type ContentBody, type CreateTagCategoryParams, type CreateTagTreeItemParams, type CustomPostCrudConfig, CustomPostCrudService, type CustomPostItem, CustomPostService, type CustomPostServiceOptions, DEFAULT_POD_URLS, type EditContentParams, type EditProductParams, type FormattedGetContentResponse, type FormattedGetProductResponse, type FormattedProductSubject, type FormattedSubject, type GetCategoriesParams, type GetCategoryResponse, type GetCommentListParams, type GetCommentsParams, type GetContentByEntityIdParams, type GetContentParams, type GetContentResponse, type GetCustomPostParams, type GetCustomPostResponse, type GetInfOfGraduatedByGraduateDateResponse, type GetProductByEntityIdParams, type GetProductParams, type GetProductResponse, type GetReactionsParams, type GetSessionClassInCurrentDayResponse, type GetTagCategoriesResponse, type GetTagTreeParams, type GetTagTreeResponse, type HandshakeResponse, type IumsResponse, IumsService, type IumsServiceOptions, type LikeCommentParams, type LikePostParams, type MetaContent, type Metadata, NotificationService, type NotificationServiceOptions, type PodFormItem, type PodFormResponse, PodFormService, type PodFormServiceOptions, type PodResponse, PodSdk, type PodSdkConfig, type PodUrlsConfig, PodspaceService, type PodspaceServiceOptions, type PodspaceUploadResponse, type PodspaceUploadResult, type ProductBody, type ProductItem, type ProductItemWithFormatted, type Rate, type ResultItem, type ResultItemWithFormatted, SANDBOX_POD_URLS, type SearchTimelineByMetadataParam, type SearchTimelineParamMetaQuery, type SearchTimelineResponse, type SearchTimelineResultItem, type SendOtpOptions, type SendSmsParams, type SendSmsResponse, type SeoType, type SocialResponse, SocialService, type SocialServiceOptions, SsoService, type SsoServiceOptions, type SsoUserProfile, type Subject, type TagCategoryItem, type TagCategoryListParams, type TagTreeAncestorsParams, type TagTreeMetadata, type TagtreesType, type TimelineResponse, type TimelineSearchBody, type TokenResponse, type UpdateCustomPostParams, type UpdateTagCategoryParams, type UpdateTagTreeItemParams, type UserPostInfo, type VerifyResponse, createPodSdk, PodSdk as default, encodeBase64, generatePodSignatureHeader, resolvePodUrls };