@rezamirzapour/pod-sdk 1.0.3 → 1.0.4

package/README.md

@@ -28,6 +28,7 @@
 | :--- | :--- | :--- | :--- |
 | **CMS Content** | `sdk.cms` | `content` | Fetch, publish, edit, draft, archive, and categorize CMS articles with generic metadata `<T, P>`. |
 | **CMS Product** | `sdk.product` / `sdk.cms.products` | `product` | Product catalog, price & discount range filters, barcode lookup, batch publish, and AI search. |
+| **CMS Tags & Tree** | `sdk.tags` / `sdk.cms.tags` | `tags` | Manage tag categories and hierarchical tag trees (nodes, parent updates, ancestors, codes). |
 | **CustomPost** | `sdk.customPost` | - | Search timeline by metadata `<T>`, custom post CRUD, and high-level typed repository. |
 | **SSO** | `sdk.sso` | - | OAuth2 handshake, OTP dispatch with digital RSA signature, OTP verify, token generation, and user profile. |
 | **Podspace** | `sdk.podspace` | - | File upload (FormData) and public/private download URL resolution. |
@@ -485,7 +486,63 @@ export class ProductsApi {
 
 ---
 
-## Deep Dive 3: CustomPost & Generic Typed Repositories
+## Deep Dive 3: CMS Tags & Tag Categories (RAD API Swagger: tag=tags)
+
+Manage tag categories and multi-level hierarchical tag trees ([Swagger documentation](https://rad-sandbox.sandpod.ir/api/documentation?tag=tags)).
+
+### Accessing Tag Services
+
+Access via `podSdk.tags` or `podSdk.cms.tags`:
+
+```typescript
+// Category Management (with Access-Token)
+const categories = await podSdk.tags.getTagCategories({ size: 20 });
+await podSdk.tags.createTagCategory({ name: 'Technology', desc: 'Tech articles' });
+await podSdk.tags.publishTagCategory(categoryId);
+
+// Public Hierarchical Tag Tree (without token, defaults to 'root')
+const rootTree = await podSdk.tags.getTagTree('root', { levelCount: 3 });
+
+// Backward-compatible shortcut
+const categoriesTree = await podSdk.cms.getCategories({ levelCount: 3 });
+
+// Tree Node Management (create, update parent, code, ancestors)
+await podSdk.tags.createTagTreeItem('technology', {
+  name: 'Next.js',
+  code: 'NEXTJS',
+  parentId: 10,
+});
+await podSdk.tags.updateTagTreeParent('technology', nodeId, newParentId);
+await podSdk.tags.updateTagTreeCode('technology', nodeId, 'NEW_CODE');
+const ancestors = await podSdk.tags.getTagTreeAncestors('technology', nodeId);
+```
+
+### Tag Methods Reference (`podSdk.tags` / `podSdk.cms.tags`)
+
+| Method | HTTP | Path | Description |
+| :--- | :--- | :--- | :--- |
+| `getTagCategories(params)` | `GET` | `/api/core/tags/category` | List tag categories (manage). |
+| `createTagCategory(params)` | `POST` | `/api/core/tags/category` | Create new tag category. |
+| `getTagCategory(id)` | `GET` | `/api/core/tags/category/{id}` | Show single tag category. |
+| `updateTagCategory(id, params)` | `PUT` | `/api/core/tags/category/{id}` | Update tag category. |
+| `publishTagCategory(id)` | `PUT` | `/api/core/tags/category/{id}/publish` | Publish tag category. |
+| `unpublishTagCategory(id)` | `PUT` | `/api/core/tags/category/{id}/unpublish` | Unpublish tag category. |
+| `getTagTree(categoryId, params)` | `GET` | `/api/core/tags/{categoryId}/tree/enable` | Get enabled tag tree (public). |
+| `getManageTagTree(categoryId, params)` | `GET` | `/api/core/tags/{categoryId}/tree/manage` | Get tag tree (manage with token). |
+| `createTagTreeItem(categoryId, params)` | `POST` | `/api/core/tags/{categoryId}/tree` | Create tag tree node for category. |
+| `getTagTreeItem(categoryId, id)` | `GET` | `/api/core/tags/{categoryId}/tree/{id}/enable` | Show enabled tag tree node. |
+| `getManageTagTreeItem(categoryId, id)` | `GET` | `/api/core/tags/{categoryId}/tree/{id}/manage` | Show tag tree node (manage). |
+| `updateTagTreeItem(categoryId, id, params)` | `PUT` | `/api/core/tags/{categoryId}/tree/{id}` | Update tag tree node. |
+| `publishTagTreeItem(categoryId, id)` | `PUT` | `/api/core/tags/{categoryId}/tree/publish/{id}` | Publish tag tree node. |
+| `unpublishTagTreeItem(categoryId, id)` | `PUT` | `/api/core/tags/{categoryId}/tree/unpublish/{id}` | Unpublish tag tree node. |
+| `updateTagTreeParent(categoryId, id, parentId)` | `PUT` | `/api/core/tags/{categoryId}/tree/parent/{id}` | Update parent of tag tree node. |
+| `getTagTreeAncestors(categoryId, id, params)` | `GET` | `/api/core/tags/{categoryId}/tree/parent/{id}/enable` | Get node ancestors (public). |
+| `getManageTagTreeAncestors(categoryId, id, params)`| `GET` | `/api/core/tags/{categoryId}/tree/parent/{id}/manage` | Get node ancestors (manage). |
+| `updateTagTreeCode(categoryId, id, code)` | `PUT` | `/api/core/tags/{categoryId}/tree/code/{id}` | Update code of tag tree node. |
+
+---
+
+## Deep Dive 4: CustomPost & Generic Typed Repositories
 
 `CustomPost` allows persisting arbitrary JSON schemas on the POD Platform. `@rezamirzapour/pod-sdk` provides two complementary approaches:
 

package/dist/index.d.mts

@@ -637,21 +637,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 +1061,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 +1314,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 +1440,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 +1605,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>;
     /**
@@ -1429,6 +1677,7 @@ declare class PodSdk {
     readonly social: SocialService;
     readonly cms: CmsService;
     readonly product: CmsProductService;
+    readonly tags: CmsTagService;
     readonly iums: IumsService;
     constructor(config: PodSdkConfig);
     /**
@@ -1448,4 +1697,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, 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, 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 };